Top Description Inners Fields Constructors Methods
org.lwjgl.llvm

public Class CXTUResourceUsage

extends Struct<CXTUResourceUsage>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

The memory usage of a CXTranslationUnit, broken into categories.

Layout


struct CXTUResourceUsage {
    void * data;
    unsigned numEntries;
    CXTUResourceUsageEntry * entries;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DATA

The struct member offsets.

public static final int
ENTRIES

The struct member offsets.

public static final int
NUMENTRIES

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
CXTUResourceUsage(long address, ByteBuffer container)

public
CXTUResourceUsage(ByteBuffer container)

Creates a CXTUResourceUsage instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static CXTUResourceUsage
calloc()

Returns a new CXTUResourceUsage instance allocated with memCalloc.

public static CXTUResourceUsage.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new CXTUResourceUsage.Buffer instance allocated with memCalloc.

public static CXTUResourceUsage
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new CXTUResourceUsage instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static CXTUResourceUsage.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new CXTUResourceUsage.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static CXTUResourceUsage
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static CXTUResourceUsage
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static CXTUResourceUsage.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static CXTUResourceUsage.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected CXTUResourceUsage
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static CXTUResourceUsage
create()

Returns a new CXTUResourceUsage instance allocated with BufferUtils.

public static CXTUResourceUsage
create(long address)

Returns a new CXTUResourceUsage instance for the specified memory address.

public static CXTUResourceUsage.Buffer
create(int
the buffer capacity
capacity
)

Returns a new CXTUResourceUsage.Buffer instance allocated with BufferUtils.

public static CXTUResourceUsage.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a CXTUResourceUsage.Buffer instance at the specified memory.

public static CXTUResourceUsage
createSafe(long address)

Like create, but returns null if address is NULL.

public static CXTUResourceUsage.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public long
data()

private data member, used for queries

public CXTUResourceUsageEntry.Buffer
entries()

an array of key-value pairs, representing the breakdown of memory usage

public static CXTUResourceUsage
malloc()

Returns a new CXTUResourceUsage instance allocated with memAlloc.

public static CXTUResourceUsage.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new CXTUResourceUsage.Buffer instance allocated with memAlloc.

public static CXTUResourceUsage
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new CXTUResourceUsage instance allocated on the specified MemoryStack.

public static CXTUResourceUsage.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new CXTUResourceUsage.Buffer instance allocated on the specified MemoryStack.

public static CXTUResourceUsage
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static CXTUResourceUsage
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static CXTUResourceUsage.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static CXTUResourceUsage.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static long
ndata(long struct)

Unsafe version of data.

public static CXTUResourceUsageEntry.Buffer
nentries(long struct)

Unsafe version of entries.

public static int
nnumEntries(long struct)

Unsafe version of numEntries.

public int
numEntries()

the number of entries in the entries array.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

DATAback to summary
public static final int DATA

The struct member offsets.

ENTRIESback to summary
public static final int ENTRIES

The struct member offsets.

NUMENTRIESback to summary
public static final int NUMENTRIES

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

CXTUResourceUsageback to summary
protected CXTUResourceUsage(long address, ByteBuffer container)
CXTUResourceUsageback to summary
public CXTUResourceUsage(ByteBuffer container)

Creates a CXTUResourceUsage 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

callocback to summary
public static CXTUResourceUsage calloc()

Returns a new CXTUResourceUsage instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static CXTUResourceUsage.Buffer calloc(int capacity)

Returns a new CXTUResourceUsage.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static CXTUResourceUsage calloc(MemoryStack stack)

Returns a new CXTUResourceUsage instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static CXTUResourceUsage.Buffer calloc(int capacity, MemoryStack stack)

Returns a new CXTUResourceUsage.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static CXTUResourceUsage callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static CXTUResourceUsage callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static CXTUResourceUsage.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static CXTUResourceUsage.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected CXTUResourceUsage create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static CXTUResourceUsage create()

Returns a new CXTUResourceUsage instance allocated with BufferUtils.

createback to summary
public static CXTUResourceUsage create(long address)

Returns a new CXTUResourceUsage instance for the specified memory address.

createback to summary
public static CXTUResourceUsage.Buffer create(int capacity)

Returns a new CXTUResourceUsage.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static CXTUResourceUsage.Buffer create(long address, int capacity)

Create a CXTUResourceUsage.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static CXTUResourceUsage createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static CXTUResourceUsage.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
databack to summary
public long data()

private data member, used for queries

Annotations
@NativeType:void *
entriesback to summary
public CXTUResourceUsageEntry.Buffer entries()

an array of key-value pairs, representing the breakdown of memory usage

Annotations
@NativeType:CXTUResourceUsageEntry *
mallocback to summary
public static CXTUResourceUsage malloc()

Returns a new CXTUResourceUsage instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static CXTUResourceUsage.Buffer malloc(int capacity)

Returns a new CXTUResourceUsage.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static CXTUResourceUsage malloc(MemoryStack stack)

Returns a new CXTUResourceUsage instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static CXTUResourceUsage.Buffer malloc(int capacity, MemoryStack stack)

Returns a new CXTUResourceUsage.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static CXTUResourceUsage mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static CXTUResourceUsage mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static CXTUResourceUsage.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static CXTUResourceUsage.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
ndataback to summary
public static long ndata(long struct)

Unsafe version of data.

nentriesback to summary
public static CXTUResourceUsageEntry.Buffer nentries(long struct)

Unsafe version of entries.

nnumEntriesback to summary
public static int nnumEntries(long struct)

Unsafe version of numEntries.

numEntriesback to summary
public int numEntries()

the number of entries in the entries array.

Annotations
@NativeType:unsigned
sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
org.lwjgl.llvm back to summary

public Class CXTUResourceUsage.Buffer

extends StructBuffer<CXTUResourceUsage, CXTUResourceUsage.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of CXTUResourceUsage structs.

Field Summary

Modifier and TypeField and Description
private static final CXTUResourceUsage

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new CXTUResourceUsage.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

the value of the CXTUResourceUsage#data field.
data
()

public CXTUResourceUsageEntry.Buffer

Returns:

a CXTUResourceUsageEntry.Buffer view of the struct array pointed to by the CXTUResourceUsage#entries field.
entries
()

protected CXTUResourceUsage
public int

Returns:

the value of the CXTUResourceUsage#numEntries field.
numEntries
()

protected CXTUResourceUsage.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final CXTUResourceUsage ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new CXTUResourceUsage.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by CXTUResourceUsage#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

databack to summary
public long data()
Returns:long

the value of the CXTUResourceUsage#data field.

Annotations
@NativeType:void *
entriesback to summary
public CXTUResourceUsageEntry.Buffer entries()
Returns:CXTUResourceUsageEntry.Buffer

a CXTUResourceUsageEntry.Buffer view of the struct array pointed to by the CXTUResourceUsage#entries field.

Annotations
@NativeType:CXTUResourceUsageEntry *
getElementFactoryback to summary
protected CXTUResourceUsage getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
numEntriesback to summary
public int numEntries()
Returns:int

the value of the CXTUResourceUsage#numEntries field.

Annotations
@NativeType:unsigned
selfback to summary
protected CXTUResourceUsage.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override