Package org.lwjgl.bgfx

Class BGFXUniformInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<BGFXUniformInfo>

org.lwjgl.bgfx.BGFXUniformInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class BGFXUniformInfo
extends Struct<BGFXUniformInfo>
implements NativeResource

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BGFXUniformInfo.Buffer	An array of BGFXUniformInfo structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	NAME	The struct member offsets.
static final int	NUM	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	TYPE	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	Description
BGFXUniformInfo(ByteBuffer container)	Creates a BGFXUniformInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static BGFXUniformInfo	calloc()	Returns a new BGFXUniformInfo instance allocated with memCalloc.
static BGFXUniformInfo.Buffer	calloc(int capacity)	Returns a new BGFXUniformInfo.Buffer instance allocated with memCalloc.
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.
static BGFXUniformInfo	calloc(MemoryStack stack)	Returns a new BGFXUniformInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static BGFXUniformInfo	callocStack()	Deprecated.
static BGFXUniformInfo.Buffer	callocStack(int capacity)	Deprecated.
static BGFXUniformInfo.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static BGFXUniformInfo	callocStack(MemoryStack stack)	Deprecated.
static BGFXUniformInfo	create()	Returns a new BGFXUniformInfo instance allocated with BufferUtils.
static BGFXUniformInfo.Buffer	create(int capacity)	Returns a new BGFXUniformInfo.Buffer instance allocated with BufferUtils.
static BGFXUniformInfo	create(long address)	Returns a new BGFXUniformInfo instance for the specified memory address.
static BGFXUniformInfo.Buffer	create(long address, int capacity)	Create a BGFXUniformInfo.Buffer instance at the specified memory.
static @Nullable BGFXUniformInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable BGFXUniformInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static BGFXUniformInfo	malloc()	Returns a new BGFXUniformInfo instance allocated with memAlloc.
static BGFXUniformInfo.Buffer	malloc(int capacity)	Returns a new BGFXUniformInfo.Buffer instance allocated with memAlloc.
static BGFXUniformInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new BGFXUniformInfo.Buffer instance allocated on the specified MemoryStack.
static BGFXUniformInfo	malloc(MemoryStack stack)	Returns a new BGFXUniformInfo instance allocated on the specified MemoryStack.
static BGFXUniformInfo	mallocStack()	Deprecated.
static BGFXUniformInfo.Buffer	mallocStack(int capacity)	Deprecated.
static BGFXUniformInfo.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static BGFXUniformInfo	mallocStack(MemoryStack stack)	Deprecated.
ByteBuffer	name()
BGFXUniformInfo	name(ByteBuffer value)	Copies the specified encoded string to the name field.
String	nameString()
static ByteBuffer	nname(long struct)	Unsafe version of name().
static void	nname(long struct, ByteBuffer value)	Unsafe version of name.
static String	nnameString(long struct)	Unsafe version of nameString().
static short	nnum(long struct)	Unsafe version of num().
static void	nnum(long struct, short value)	Unsafe version of num.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
short	num()
BGFXUniformInfo	num(short value)	Sets the specified value to the num field.
BGFXUniformInfo	set(ByteBuffer name, int type, short num)	Initializes this struct with the specified values.
BGFXUniformInfo	set(BGFXUniformInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	type()
BGFXUniformInfo	type(int value)	Sets the specified value to the type field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

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 Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

NAME

public static final int NAME

The struct member offsets.

TYPE

public static final int TYPE

The struct member offsets.

NUM

public static final int NUM

The struct member offsets.

Constructor Details

BGFXUniformInfo

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<BGFXUniformInfo>

name

public ByteBuffer name()

Returns:

a ByteBuffer view of the name field.

nameString

public String nameString()

Returns:

the null-terminated string stored in the name field.

type

public int type()

Returns:

the value of the type field.

num

public short num()

Returns:

the value of the num field.

name

public BGFXUniformInfo name(ByteBuffer value)

Copies the specified encoded string to the name field.

type

public BGFXUniformInfo type(int value)

Sets the specified value to the type field.

num

public BGFXUniformInfo num(short value)

Sets the specified value to the num field.

set

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

Initializes this struct with the specified values.

set

public BGFXUniformInfo set(BGFXUniformInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static BGFXUniformInfo malloc()

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

calloc

public static BGFXUniformInfo calloc()

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

create

public static BGFXUniformInfo create()

Returns a new BGFXUniformInfo instance allocated with BufferUtils.

create

public static BGFXUniformInfo create(long address)

Returns a new BGFXUniformInfo instance for the specified memory address.

createSafe

public static @Nullable BGFXUniformInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static BGFXUniformInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static BGFXUniformInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static BGFXUniformInfo.Buffer create(int capacity)

Returns a new BGFXUniformInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a BGFXUniformInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static BGFXUniformInfo mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static BGFXUniformInfo callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static BGFXUniformInfo mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static BGFXUniformInfo callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static BGFXUniformInfo.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static BGFXUniformInfo.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static BGFXUniformInfo.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static BGFXUniformInfo.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static BGFXUniformInfo malloc(MemoryStack stack)

Returns a new BGFXUniformInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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 - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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 - the buffer capacity

stack - the stack from which to allocate

nname

public static ByteBuffer nname(long struct)

Unsafe version of name().

nnameString

public static String nnameString(long struct)

Unsafe version of nameString().

ntype

public static int ntype(long struct)

Unsafe version of type().

nnum

public static short nnum(long struct)

Unsafe version of num().

nname

public static void nname(long struct,
 ByteBuffer value)

Unsafe version of name.

ntype

public static void ntype(long struct,
 int value)

Unsafe version of type.

nnum

public static void nnum(long struct,
 short value)

Unsafe version of num.