Top Description Inners Fields Constructors Methods
org.lwjgl.util.freetype

public Class FT_StreamDesc

extends Struct<FT_StreamDesc>
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 union type used to store either a long or a pointer. This is used to store a file descriptor or a FILE* in an input stream.

Layout


union FT_StreamDesc {
    long value;
    void * pointer;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
FT_StreamDesc.Buffer

An array of FT_StreamDesc structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
POINTER

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
VALUE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
FT_StreamDesc(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static FT_StreamDesc
calloc()

Returns a new FT_StreamDesc instance allocated with memCalloc.

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

Returns a new FT_StreamDesc.Buffer instance allocated with memCalloc.

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

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

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

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

protected FT_StreamDesc
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 FT_StreamDesc
create()

Returns a new FT_StreamDesc instance allocated with BufferUtils.

public static FT_StreamDesc
create(long address)

Returns a new FT_StreamDesc instance for the specified memory address.

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

Returns a new FT_StreamDesc.Buffer instance allocated with BufferUtils.

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

Create a FT_StreamDesc.Buffer instance at the specified memory.

public static FT_StreamDesc
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static FT_StreamDesc
malloc()

Returns a new FT_StreamDesc instance allocated with memAlloc.

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

Returns a new FT_StreamDesc.Buffer instance allocated with memAlloc.

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

Returns a new FT_StreamDesc instance allocated on the specified MemoryStack.

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

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

public static long
npointer(long struct)

Unsafe version of pointer.

public static void
npointer(long struct, long value)

Unsafe version of pointer.

public static long
nvalue(long struct)

Unsafe version of value.

public static void
nvalue(long struct, long value)

Unsafe version of value.

public long

Returns:

the value of the pointer field.
pointer
()

public FT_StreamDesc
pointer(long value)

Sets the specified value to the pointer field.

public FT_StreamDesc

Returns:

this struct
set
(FT_StreamDesc
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

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

Returns sizeof(struct).
public long

Returns:

the value of the value field.
value
()

public FT_StreamDesc
value(long value)

Sets the specified value to the value field.

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.

POINTERback to summary
public static final int POINTER

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

VALUEback to summary
public static final int VALUE

The struct member offsets.

Constructor Detail

FT_StreamDescback to summary
protected FT_StreamDesc(long address, ByteBuffer container)
FT_StreamDescback to summary
public FT_StreamDesc(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static FT_StreamDesc calloc(MemoryStack stack)

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

Returns a new FT_StreamDesc.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

createback to summary
protected FT_StreamDesc 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 FT_StreamDesc create()

Returns a new FT_StreamDesc instance allocated with BufferUtils.

createback to summary
public static FT_StreamDesc create(long address)

Returns a new FT_StreamDesc instance for the specified memory address.

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

Returns a new FT_StreamDesc.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a FT_StreamDesc.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static FT_StreamDesc createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static FT_StreamDesc malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static FT_StreamDesc malloc(MemoryStack stack)

Returns a new FT_StreamDesc instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

npointerback to summary
public static long npointer(long struct)

Unsafe version of pointer.

npointerback to summary
public static void npointer(long struct, long value)

Unsafe version of pointer.

nvalueback to summary
public static long nvalue(long struct)

Unsafe version of value.

nvalueback to summary
public static void nvalue(long struct, long value)

Unsafe version of value.

pointerback to summary
public long pointer()
Returns:long

the value of the pointer field.

Annotations
@NativeType:void *
pointerback to summary
public FT_StreamDesc pointer(long value)

Sets the specified value to the pointer field.

setback to summary
public FT_StreamDesc set(FT_StreamDesc src)

Copies the specified struct data to this struct.

Parameters
src:FT_StreamDesc

the source struct

Returns:FT_StreamDesc

this struct

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
valueback to summary
public long value()
Returns:long

the value of the value field.

valueback to summary
public FT_StreamDesc value(long value)

Sets the specified value to the value field.

org.lwjgl.util.freetype back to summary

public Class FT_StreamDesc.Buffer

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

An array of FT_StreamDesc structs.

Field Summary

Modifier and TypeField and Description
private static final FT_StreamDesc

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new FT_StreamDesc.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
protected FT_StreamDesc
public long

Returns:

the value of the pointer field.
pointer
()

public FT_StreamDesc.Buffer
pointer(long value)

Sets the specified value to the pointer field.

protected FT_StreamDesc.Buffer
public long

Returns:

the value of the value field.
value
()

public FT_StreamDesc.Buffer
value(long value)

Sets the specified value to the value field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final FT_StreamDesc ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new FT_StreamDesc.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 FT_StreamDesc#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

getElementFactoryback to summary
protected FT_StreamDesc getElementFactory()

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

Annotations
@Override
pointerback to summary
public long pointer()
Returns:long

the value of the pointer field.

Annotations
@NativeType:void *
pointerback to summary
public FT_StreamDesc.Buffer pointer(long value)

Sets the specified value to the pointer field.

selfback to summary
protected FT_StreamDesc.Buffer self()

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

Annotations
@Override
valueback to summary
public long value()
Returns:long

the value of the value field.

valueback to summary
public FT_StreamDesc.Buffer value(long value)

Sets the specified value to the value field.