Package org.lwjgl.util.spvc

Class SpvcReflectedBuiltinResource

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<SpvcReflectedBuiltinResource>

org.lwjgl.util.spvc.SpvcReflectedBuiltinResource

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class SpvcReflectedBuiltinResource
extends org.lwjgl.system.Struct<SpvcReflectedBuiltinResource>
implements org.lwjgl.system.NativeResource

Layout

 struct spvc_reflected_builtin_resource {
     SpvBuiltIn builtin();
     spvc_type_id value_type_id();
     spvc_reflected_resource resource();
 }

Nested Class Summary

Nested Classes

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

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

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
int	builtin()	This is mostly here to support reflection of builtins such as Position/PointSize/CullDistance/ClipDistance.
SpvcReflectedBuiltinResource	builtin(int value)	Sets the specified value to the builtin() field.
static SpvcReflectedBuiltinResource	calloc()	Returns a new SpvcReflectedBuiltinResource instance allocated with memCalloc.
static SpvcReflectedBuiltinResource.Buffer	calloc(int capacity)	Returns a new SpvcReflectedBuiltinResource.Buffer instance allocated with memCalloc.
static SpvcReflectedBuiltinResource.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new SpvcReflectedBuiltinResource.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static SpvcReflectedBuiltinResource	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new SpvcReflectedBuiltinResource instance allocated on the specified MemoryStack and initializes all its bits to zero.
static SpvcReflectedBuiltinResource	create()	Returns a new SpvcReflectedBuiltinResource instance allocated with BufferUtils.
static SpvcReflectedBuiltinResource.Buffer	create(int capacity)	Returns a new SpvcReflectedBuiltinResource.Buffer instance allocated with BufferUtils.
static SpvcReflectedBuiltinResource	create(long address)	Returns a new SpvcReflectedBuiltinResource instance for the specified memory address.
static SpvcReflectedBuiltinResource.Buffer	create(long address, int capacity)	Create a SpvcReflectedBuiltinResource.Buffer instance at the specified memory.
static @Nullable SpvcReflectedBuiltinResource	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable SpvcReflectedBuiltinResource.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static SpvcReflectedBuiltinResource	malloc()	Returns a new SpvcReflectedBuiltinResource instance allocated with memAlloc.
static SpvcReflectedBuiltinResource.Buffer	malloc(int capacity)	Returns a new SpvcReflectedBuiltinResource.Buffer instance allocated with memAlloc.
static SpvcReflectedBuiltinResource.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new SpvcReflectedBuiltinResource.Buffer instance allocated on the specified MemoryStack.
static SpvcReflectedBuiltinResource	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new SpvcReflectedBuiltinResource instance allocated on the specified MemoryStack.
static int	nbuiltin(long struct)	Unsafe version of builtin().
static void	nbuiltin(long struct, int value)	Unsafe version of builtin.
static SpvcReflectedResource	nresource(long struct)	Unsafe version of resource().
static void	nresource(long struct, SpvcReflectedResource value)	Unsafe version of resource.
static int	nvalue_type_id(long struct)	Unsafe version of value_type_id().
static void	nvalue_type_id(long struct, int value)	Unsafe version of value_type_id.
SpvcReflectedResource	resource()	This refers to the base resource which contains the builtin.
SpvcReflectedBuiltinResource	resource(Consumer<SpvcReflectedResource> consumer)	Passes the resource() field to the specified Consumer.
SpvcReflectedBuiltinResource	resource(SpvcReflectedResource value)	Copies the specified SpvcReflectedResource to the resource() field.
SpvcReflectedBuiltinResource	set(int builtin, int value_type_id, SpvcReflectedResource resource)	Initializes this struct with the specified values.
SpvcReflectedBuiltinResource	set(SpvcReflectedBuiltinResource src)	Copies the specified struct data to this struct.
int	sizeof()
static void	validate(long struct)	Validates pointer members that should not be NULL.
int	value_type_id()	This is the actual value type of the builtin.
SpvcReflectedBuiltinResource	value_type_id(int value)	Sets the specified value to the value_type_id() 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.

BUILTIN

public static final int BUILTIN

The struct member offsets.

VALUE_TYPE_ID

public static final int VALUE_TYPE_ID

The struct member offsets.

RESOURCE

public static final int RESOURCE

The struct member offsets.

Constructor Details

SpvcReflectedBuiltinResource

public SpvcReflectedBuiltinResource(ByteBuffer container)

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

Specified by:

sizeof in class org.lwjgl.system.Struct<SpvcReflectedBuiltinResource>

builtin

public int builtin()

This is mostly here to support reflection of builtins such as Position/PointSize/CullDistance/ClipDistance.

This needs to be different from Resource since we can collect builtins from blocks. A builtin present here does not necessarily mean it's considered an active builtin, since variable ID "activeness" is only tracked on OpVariable level, not Block members. For that, compiler_update_active_builtins -> compiler_has_active_builtin can be used to further refine the reflection.

value_type_id

public int value_type_id()

This is the actual value type of the builtin.

Typically float4, float, array<float, N> for the gl_PerVertex builtins. If the builtin is a control point, the control point array type will be stripped away here as appropriate.

resource

public SpvcReflectedResource resource()

This refers to the base resource which contains the builtin.

If resource is a Block, it can hold multiple builtins, or it might not be a block. For advanced reflection scenarios, all information in builtin/value_type_id can be deduced, it's just more convenient this way.

builtin

public SpvcReflectedBuiltinResource builtin(int value)

Sets the specified value to the builtin() field.

value_type_id

public SpvcReflectedBuiltinResource value_type_id(int value)

Sets the specified value to the value_type_id() field.

resource

public SpvcReflectedBuiltinResource resource(SpvcReflectedResource value)

Copies the specified SpvcReflectedResource to the resource() field.

resource

public SpvcReflectedBuiltinResource resource(Consumer<SpvcReflectedResource> consumer)

Passes the resource() field to the specified Consumer.

set

public SpvcReflectedBuiltinResource set(int builtin,
 int value_type_id,
 SpvcReflectedResource resource)

Initializes this struct with the specified values.

set

public SpvcReflectedBuiltinResource set(SpvcReflectedBuiltinResource src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static SpvcReflectedBuiltinResource malloc()

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

calloc

public static SpvcReflectedBuiltinResource calloc()

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

create

public static SpvcReflectedBuiltinResource create()

Returns a new SpvcReflectedBuiltinResource instance allocated with BufferUtils.

create

public static SpvcReflectedBuiltinResource create(long address)

Returns a new SpvcReflectedBuiltinResource instance for the specified memory address.

createSafe

public static @Nullable SpvcReflectedBuiltinResource createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static SpvcReflectedBuiltinResource.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static SpvcReflectedBuiltinResource.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static SpvcReflectedBuiltinResource.Buffer create(int capacity)

Returns a new SpvcReflectedBuiltinResource.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a SpvcReflectedBuiltinResource.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static SpvcReflectedBuiltinResource malloc(org.lwjgl.system.MemoryStack stack)

Returns a new SpvcReflectedBuiltinResource instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static SpvcReflectedBuiltinResource calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static SpvcReflectedBuiltinResource.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static SpvcReflectedBuiltinResource.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

nbuiltin

public static int nbuiltin(long struct)

Unsafe version of builtin().

nvalue_type_id

public static int nvalue_type_id(long struct)

Unsafe version of value_type_id().

nresource

public static SpvcReflectedResource nresource(long struct)

Unsafe version of resource().

nbuiltin

public static void nbuiltin(long struct,
 int value)

Unsafe version of builtin.

nvalue_type_id

public static void nvalue_type_id(long struct,
 int value)

Unsafe version of value_type_id.

nresource

public static void nresource(long struct,
 SpvcReflectedResource value)

Unsafe version of resource.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate