Top Description Inners Fields Constructors Methods
org.lwjgl.bgfx

public Class BGFXUniformInfo

extends Struct<BGFXUniformInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct bgfx_uniform_info_t
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Uniform info.

Layout


struct bgfx_uniform_info_t {
    char name[256];
    bgfx_uniform_type_t type;
    uint16_t num;
}

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
NAME

The struct member offsets.

public static final int
NUM

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
BGFXUniformInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static BGFXUniformInfo
calloc()

Returns a new BGFXUniformInfo instance allocated with memCalloc.

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

Returns a new BGFXUniformInfo.Buffer instance allocated with memCalloc.

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

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

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

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

public static BGFXUniformInfo
callocStack()

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

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

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

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

Returns a new BGFXUniformInfo instance allocated with BufferUtils.

public static BGFXUniformInfo
create(long address)

Returns a new BGFXUniformInfo instance for the specified memory address.

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

Returns a new BGFXUniformInfo.Buffer instance allocated with BufferUtils.

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

Create a BGFXUniformInfo.Buffer instance at the specified memory.

public static BGFXUniformInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static BGFXUniformInfo
malloc()

Returns a new BGFXUniformInfo instance allocated with memAlloc.

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

Returns a new BGFXUniformInfo.Buffer instance allocated with memAlloc.

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

Returns a new BGFXUniformInfo instance allocated on the specified MemoryStack.

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

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

public static BGFXUniformInfo
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public ByteBuffer
name()

uniform name

public BGFXUniformInfo
name(ByteBuffer value)

Copies the specified encoded string to the name field.

public String
nameString()

uniform name

public static ByteBuffer
nname(long struct)

Unsafe version of name.

public static void
nname(long struct, ByteBuffer value)

Unsafe version of name.

public static String
nnameString(long struct)

Unsafe version of nameString.

public static short
nnum(long struct)

Unsafe version of num.

public static void
nnum(long struct, short value)

Unsafe version of num.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public short
num()

number of elements in array

public BGFXUniformInfo
num(short value)

Sets the specified value to the num field.

public BGFXUniformInfo
set(ByteBuffer name, int type, short num)

Initializes this struct with the specified values.

public BGFXUniformInfo

Returns:

this struct
set
(BGFXUniformInfo
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 int
type()

uniform type

public BGFXUniformInfo
type(int value)

Sets the specified value to the type 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.

NAMEback to summary
public static final int NAME

The struct member offsets.

NUMback to summary
public static final int NUM

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

BGFXUniformInfoback to summary
protected BGFXUniformInfo(long address, ByteBuffer container)
BGFXUniformInfoback to summary
public BGFXUniformInfo(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static BGFXUniformInfo calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new BGFXUniformInfo instance allocated with BufferUtils.

createback to summary
public static BGFXUniformInfo create(long address)

Returns a new BGFXUniformInfo instance for the specified memory address.

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

Returns a new BGFXUniformInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a BGFXUniformInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static BGFXUniformInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static BGFXUniformInfo malloc(MemoryStack stack)

Returns a new BGFXUniformInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nameback to summary
public ByteBuffer name()

uniform name

Annotations
@NativeType:char[256]
nameback to summary
public BGFXUniformInfo name(ByteBuffer value)

Copies the specified encoded string to the name field.

nameStringback to summary
public String nameString()

uniform name

Annotations
@NativeType:char[256]
nnameback to summary
public static ByteBuffer nname(long struct)

Unsafe version of name.

nnameback to summary
public static void nname(long struct, ByteBuffer value)

Unsafe version of name.

nnameStringback to summary
public static String nnameString(long struct)

Unsafe version of nameString.

nnumback to summary
public static short nnum(long struct)

Unsafe version of num.

nnumback to summary
public static void nnum(long struct, short value)

Unsafe version of num.

ntypeback to summary
public static int ntype(long struct)

Unsafe version of type.

ntypeback to summary
public static void ntype(long struct, int value)

Unsafe version of type.

numback to summary
public short num()

number of elements in array

Annotations
@NativeType:uint16_t
numback to summary
public BGFXUniformInfo num(short value)

Sets the specified value to the num field.

setback to summary
public BGFXUniformInfo set(ByteBuffer name, int type, short num)

Initializes this struct with the specified values.

setback to summary
public BGFXUniformInfo set(BGFXUniformInfo src)

Copies the specified struct data to this struct.

Parameters
src:BGFXUniformInfo

the source struct

Returns:BGFXUniformInfo

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
typeback to summary
public int type()

uniform type

Annotations
@NativeType:bgfx_uniform_type_t
typeback to summary
public BGFXUniformInfo type(int value)

Sets the specified value to the type field.

org.lwjgl.bgfx back to summary

public Class BGFXUniformInfo.Buffer

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

An array of BGFXUniformInfo structs.

Field Summary

Modifier and TypeField and Description
private static final BGFXUniformInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

a ByteBuffer view of the BGFXUniformInfo#name field.
name
()

public BGFXUniformInfo.Buffer
name(ByteBuffer value)

Copies the specified encoded string to the BGFXUniformInfo#name field.

public String

Returns:

the null-terminated string stored in the BGFXUniformInfo#name field.
nameString
()

public short

Returns:

the value of the BGFXUniformInfo#num field.
num
()

public BGFXUniformInfo.Buffer
num(short value)

Sets the specified value to the BGFXUniformInfo#num field.

protected BGFXUniformInfo.Buffer
public int

Returns:

the value of the BGFXUniformInfo#type field.
type
()

public BGFXUniformInfo.Buffer
type(int value)

Sets the specified value to the BGFXUniformInfo#type field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final BGFXUniformInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new BGFXUniformInfo.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 BGFXUniformInfo#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 BGFXUniformInfo getElementFactory()

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

Annotations
@Override
nameback to summary
public ByteBuffer name()
Returns:ByteBuffer

a ByteBuffer view of the BGFXUniformInfo#name field.

Annotations
@NativeType:char[256]
nameback to summary
public BGFXUniformInfo.Buffer name(ByteBuffer value)

Copies the specified encoded string to the BGFXUniformInfo#name field.

nameStringback to summary
public String nameString()
Returns:String

the null-terminated string stored in the BGFXUniformInfo#name field.

Annotations
@NativeType:char[256]
numback to summary
public short num()
Returns:short

the value of the BGFXUniformInfo#num field.

Annotations
@NativeType:uint16_t
numback to summary
public BGFXUniformInfo.Buffer num(short value)

Sets the specified value to the BGFXUniformInfo#num field.

selfback to summary
protected BGFXUniformInfo.Buffer self()

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

Annotations
@Override
typeback to summary
public int type()
Returns:int

the value of the BGFXUniformInfo#type field.

Annotations
@NativeType:bgfx_uniform_type_t
typeback to summary
public BGFXUniformInfo.Buffer type(int value)

Sets the specified value to the BGFXUniformInfo#type field.