CXCompletionResult (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.llvm.CXCompletionResult

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class CXCompletionResult
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
A single result of code completion.
Member documentation
- CursorKind – the kind of entity that this completion refers to.
  The cursor kind will be a macro, keyword, or a declaration (one of the *Decl cursor kinds), describing the entity that the completion is referring to.
- CompletionString – the code-completion string that describes how to insert this code-completion result into the editing buffer
Layout
```
 struct CXCompletionResult {
     enum CXCursorKind CursorKind;
     CXCompletionString CompletionString;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CXCompletionResult.Buffer
An array of CXCompletionResult structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`CXCompletionResult.Buffer` An array of `CXCompletionResult` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`COMPLETIONSTRING` The struct member offsets.
`static int`	`CURSORKIND` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`CXCompletionResult(java.nio.ByteBuffer container)` Creates a `CXCompletionResult` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CXCompletionResult`	`calloc()` Returns a new `CXCompletionResult` instance allocated with `memCalloc`.
`static CXCompletionResult.Buffer`	`calloc(int capacity)` Returns a new `CXCompletionResult.Buffer` instance allocated with `memCalloc`.
`static CXCompletionResult`	`callocStack()` Returns a new `CXCompletionResult` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static CXCompletionResult.Buffer`	`callocStack(int capacity)` Returns a new `CXCompletionResult.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static CXCompletionResult.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `CXCompletionResult.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static CXCompletionResult`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `CXCompletionResult` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`long`	`CompletionString()` Returns the value of the `CompletionString` field.
`static CXCompletionResult`	`create()` Returns a new `CXCompletionResult` instance allocated with `BufferUtils`.
`static CXCompletionResult.Buffer`	`create(int capacity)` Returns a new `CXCompletionResult.Buffer` instance allocated with `BufferUtils`.
`static CXCompletionResult`	`create(long address)` Returns a new `CXCompletionResult` instance for the specified memory address.
`static CXCompletionResult.Buffer`	`create(long address, int capacity)` Create a `CXCompletionResult.Buffer` instance at the specified memory.
`static CXCompletionResult`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static CXCompletionResult.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`CursorKind()` Returns the value of the `CursorKind` field.
`static CXCompletionResult`	`malloc()` Returns a new `CXCompletionResult` instance allocated with `memAlloc`.
`static CXCompletionResult.Buffer`	`malloc(int capacity)` Returns a new `CXCompletionResult.Buffer` instance allocated with `memAlloc`.
`static CXCompletionResult`	`mallocStack()` Returns a new `CXCompletionResult` instance allocated on the thread-local `MemoryStack`.
`static CXCompletionResult.Buffer`	`mallocStack(int capacity)` Returns a new `CXCompletionResult.Buffer` instance allocated on the thread-local `MemoryStack`.
`static CXCompletionResult.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `CXCompletionResult.Buffer` instance allocated on the specified `MemoryStack`.
`static CXCompletionResult`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `CXCompletionResult` instance allocated on the specified `MemoryStack`.
`static long`	`nCompletionString(long struct)` Unsafe version of `CompletionString()`.
`static int`	`nCursorKind(long struct)` Unsafe version of `CursorKind()`.
`int`	`sizeof()`

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - CURSORKIND
```
public static final int CURSORKIND
```
    The struct member offsets.
  - COMPLETIONSTRING
```
public static final int COMPLETIONSTRING
```
    The struct member offsets.
- Constructor Detail
  - CXCompletionResult
```
public CXCompletionResult(java.nio.ByteBuffer container)
```
    Creates a CXCompletionResult instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.
    The created instance holds a strong reference to the container object.
- Method Detail
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - CursorKind
```
public int CursorKind()
```
    Returns the value of the CursorKind field.
  - CompletionString
```
public long CompletionString()
```
    Returns the value of the CompletionString field.
  - malloc
```
public static CXCompletionResult malloc()
```
    Returns a new CXCompletionResult instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static CXCompletionResult calloc()
```
    Returns a new CXCompletionResult instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static CXCompletionResult create()
```
    Returns a new CXCompletionResult instance allocated with BufferUtils.
  - create
```
public static CXCompletionResult create(long address)
```
    Returns a new CXCompletionResult instance for the specified memory address.
  - createSafe
```
@Nullable
public static CXCompletionResult createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static CXCompletionResult.Buffer malloc(int capacity)
```
    Returns a new CXCompletionResult.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static CXCompletionResult.Buffer calloc(int capacity)
```
    Returns a new CXCompletionResult.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static CXCompletionResult.Buffer create(int capacity)
```
    Returns a new CXCompletionResult.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static CXCompletionResult.Buffer create(long address,
                                               int capacity)
```
    Create a CXCompletionResult.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static CXCompletionResult.Buffer createSafe(long address,
                                                             int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static CXCompletionResult mallocStack()
```
    Returns a new CXCompletionResult instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static CXCompletionResult callocStack()
```
    Returns a new CXCompletionResult instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static CXCompletionResult mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new CXCompletionResult instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static CXCompletionResult callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new CXCompletionResult instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static CXCompletionResult.Buffer mallocStack(int capacity)
```
    Returns a new CXCompletionResult.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static CXCompletionResult.Buffer callocStack(int capacity)
```
    Returns a new CXCompletionResult.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static CXCompletionResult.Buffer mallocStack(int capacity,
                                                    org.lwjgl.system.MemoryStack stack)
```
    Returns a new CXCompletionResult.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static CXCompletionResult.Buffer callocStack(int capacity,
                                                    org.lwjgl.system.MemoryStack stack)
```
    Returns a new CXCompletionResult.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nCursorKind
```
public static int nCursorKind(long struct)
```
    Unsafe version of CursorKind().
  - nCompletionString
```
public static long nCompletionString(long struct)
```
    Unsafe version of CompletionString().

Class CXCompletionResult

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

CURSORKIND

COMPLETIONSTRING

Constructor Detail

CXCompletionResult

Method Detail

sizeof

CursorKind

CompletionString

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nCursorKind

nCompletionString