Top Description Inners Fields Constructors Methods
org.lwjgl.llvm

public Class CXString

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

A character string.

The CXString type is used to return strings from the interface when the ownership of that string might differ from one call to the next. Use getCString to retrieve the string data and, once finished with the string data, call disposeString to free the string.

Layout


struct CXString {
    void const * data;
    unsigned private_flags;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
CXString.Buffer

An array of CXString structs.

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
PRIVATE_FLAGS

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
CXString(long address, ByteBuffer container)

public
CXString(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static CXString
calloc()

Returns a new CXString instance allocated with memCalloc.

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

Returns a new CXString.Buffer instance allocated with memCalloc.

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

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

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

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

public static CXString
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
protected CXString
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 CXString
create()

Returns a new CXString instance allocated with BufferUtils.

public static CXString
create(long address)

Returns a new CXString instance for the specified memory address.

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

Returns a new CXString.Buffer instance allocated with BufferUtils.

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

Create a CXString.Buffer instance at the specified memory.

public static CXString
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the data field.
data
(int
the number of elements in the returned buffer
capacity
)

public static CXString
malloc()

Returns a new CXString instance allocated with memAlloc.

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

Returns a new CXString.Buffer instance allocated with memAlloc.

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

Returns a new CXString instance allocated on the specified MemoryStack.

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

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

public static CXString
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static ByteBuffer
ndata(long struct, int capacity)

Unsafe version of data.

public static int
nprivate_flags(long struct)

Unsafe version of private_flags.

public int

Returns:

the value of the private_flags field.
private_flags
()

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.

PRIVATE_FLAGSback to summary
public static final int PRIVATE_FLAGS

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

CXStringback to summary
protected CXString(long address, ByteBuffer container)
CXStringback to summary
public CXString(ByteBuffer container)

Creates a CXString 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 CXString calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static CXString calloc(MemoryStack stack)

Returns a new CXString 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 CXString.Buffer calloc(int capacity, MemoryStack stack)

Returns a new CXString.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 CXString callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static CXString.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 CXString 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 CXString create()

Returns a new CXString instance allocated with BufferUtils.

createback to summary
public static CXString create(long address)

Returns a new CXString instance for the specified memory address.

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

Returns a new CXString.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a CXString.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static CXString createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
databack to summary
public ByteBuffer data(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the data field.

Annotations
@NativeType:void const *
mallocback to summary
public static CXString malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static CXString malloc(MemoryStack stack)

Returns a new CXString instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new CXString.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 CXString mallocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static CXString.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 ByteBuffer ndata(long struct, int capacity)

Unsafe version of data.

nprivate_flagsback to summary
public static int nprivate_flags(long struct)

Unsafe version of private_flags.

private_flagsback to summary
public int private_flags()
Returns:int

the value of the private_flags field.

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 CXString.Buffer

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

An array of CXString structs.

Field Summary

Modifier and TypeField and Description
private static final CXString

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new CXString.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 ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the data field.
data
(int
the number of elements in the returned buffer
capacity
)

protected CXString
public int

Returns:

the value of the private_flags field.
private_flags
()

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

Field Detail

ELEMENT_FACTORYback to summary
private static final CXString ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new CXString.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 CXString#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 ByteBuffer data(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the data field.

Annotations
@NativeType:void const *
getElementFactoryback to summary
protected CXString getElementFactory()

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

Annotations
@Override
private_flagsback to summary
public int private_flags()
Returns:int

the value of the private_flags field.

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

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

Annotations
@Override