CXComment (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:: java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class CXComment
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource

A parsed comment.

Layout


 struct CXComment {
     void const * ASTNode;
     CXTranslationUnit TranslationUnit;
 }

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CXComment.Buffer
An array of CXComment 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`	`CXComment.Buffer` An array of `CXComment` structs.

Field Summary

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

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

Constructor Summary

Constructors
Constructor and Description

CXComment(java.nio.ByteBuffer container)
Creates a CXComment instance at the current position of the specified ByteBuffer container.

Constructors
Constructor and Description
`CXComment(java.nio.ByteBuffer container)` Creates a `CXComment` 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
`long`	`ASTNode()` Returns the value of the `ASTNode` field.
`static CXComment`	`calloc()` Returns a new `CXComment` instance allocated with `memCalloc`.
`static CXComment.Buffer`	`calloc(int capacity)` Returns a new `CXComment.Buffer` instance allocated with `memCalloc`.
`static CXComment`	`callocStack()` Returns a new `CXComment` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static CXComment.Buffer`	`callocStack(int capacity)` Returns a new `CXComment.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static CXComment.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `CXComment.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static CXComment`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `CXComment` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static CXComment`	`create()` Returns a new `CXComment` instance allocated with `BufferUtils`.
`static CXComment.Buffer`	`create(int capacity)` Returns a new `CXComment.Buffer` instance allocated with `BufferUtils`.
`static CXComment`	`create(long address)` Returns a new `CXComment` instance for the specified memory address.
`static CXComment.Buffer`	`create(long address, int capacity)` Create a `CXComment.Buffer` instance at the specified memory.
`static CXComment`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static CXComment.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static CXComment`	`malloc()` Returns a new `CXComment` instance allocated with `memAlloc`.
`static CXComment.Buffer`	`malloc(int capacity)` Returns a new `CXComment.Buffer` instance allocated with `memAlloc`.
`static CXComment`	`mallocStack()` Returns a new `CXComment` instance allocated on the thread-local `MemoryStack`.
`static CXComment.Buffer`	`mallocStack(int capacity)` Returns a new `CXComment.Buffer` instance allocated on the thread-local `MemoryStack`.
`static CXComment.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `CXComment.Buffer` instance allocated on the specified `MemoryStack`.
`static CXComment`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `CXComment` instance allocated on the specified `MemoryStack`.
`static long`	`nASTNode(long struct)` Unsafe version of `ASTNode()`.
`static long`	`nTranslationUnit(long struct)` Unsafe version of `TranslationUnit()`.
`int`	`sizeof()`
`long`	`TranslationUnit()` Returns the value of the `TranslationUnit` field.

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.
  - ASTNODE
```
public static final int ASTNODE
```
    The struct member offsets.
  - TRANSLATIONUNIT
```
public static final int TRANSLATIONUNIT
```
    The struct member offsets.
- Constructor Detail
  - CXComment
```
public CXComment(java.nio.ByteBuffer container)
```
    Creates a CXComment 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
  - ASTNode
```
public long ASTNode()
```
    Returns the value of the ASTNode field.
  - TranslationUnit
```
public long TranslationUnit()
```
    Returns the value of the TranslationUnit field.
  - malloc
```
public static CXComment malloc()
```
    Returns a new CXComment instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static CXComment calloc()
```
    Returns a new CXComment instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static CXComment create()
```
    Returns a new CXComment instance allocated with BufferUtils.
  - create
```
public static CXComment create(long address)
```
    Returns a new CXComment instance for the specified memory address.
  - createSafe
```
@Nullable
public static CXComment createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static CXComment.Buffer malloc(int capacity)
```
    Returns a new CXComment.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static CXComment.Buffer calloc(int capacity)
```
    Returns a new CXComment.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static CXComment.Buffer create(int capacity)
```
    Returns a new CXComment.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static CXComment.Buffer create(long address,
                                      int capacity)
```
    Create a CXComment.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static CXComment.Buffer createSafe(long address,
                                                    int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static CXComment mallocStack()
```
    Returns a new CXComment instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static CXComment callocStack()
```
    Returns a new CXComment instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static CXComment mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new CXComment instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static CXComment callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new CXComment instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static CXComment.Buffer mallocStack(int capacity)
```
    Returns a new CXComment.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static CXComment.Buffer callocStack(int capacity)
```
    Returns a new CXComment.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static CXComment.Buffer mallocStack(int capacity,
                                           org.lwjgl.system.MemoryStack stack)
```
    Returns a new CXComment.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static CXComment.Buffer callocStack(int capacity,
                                           org.lwjgl.system.MemoryStack stack)
```
    Returns a new CXComment.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
  - nASTNode
```
public static long nASTNode(long struct)
```
    Unsafe version of ASTNode().
  - nTranslationUnit
```
public static long nTranslationUnit(long struct)
```
    Unsafe version of TranslationUnit().

Class CXComment

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

ASTNODE

TRANSLATIONUNIT

Constructor Detail

CXComment

Method Detail

sizeof

ASTNode

TranslationUnit

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nASTNode

nTranslationUnit