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

public Class SpvcReflectedResource

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

Layout


struct spvc_reflected_resource {
    spvc_variable_id id;
    spvc_type_id base_type_id;
    spvc_type_id type_id;
    char const * name;
}

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
BASE_TYPE_ID

The struct member offsets.

public static final int
ID

The struct member offsets.

public static final int
NAME

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TYPE_ID

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
SpvcReflectedResource(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public int
base_type_id()

The base type of the declared resource.

public SpvcReflectedResource
base_type_id(int value)

Sets the specified value to the base_type_id field.

public static SpvcReflectedResource
calloc()

Returns a new SpvcReflectedResource instance allocated with memCalloc.

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

Returns a new SpvcReflectedResource.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new SpvcReflectedResource instance allocated with BufferUtils.

public static SpvcReflectedResource
create(long address)

Returns a new SpvcReflectedResource instance for the specified memory address.

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

Returns a new SpvcReflectedResource.Buffer instance allocated with BufferUtils.

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

Create a SpvcReflectedResource.Buffer instance at the specified memory.

public static SpvcReflectedResource
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
id()

Resources are identified with their SPIR-V ID. This is the ID of the OpVariable.

public SpvcReflectedResource
id(int value)

Sets the specified value to the id field.

public static SpvcReflectedResource
malloc()

Returns a new SpvcReflectedResource instance allocated with memAlloc.

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

Returns a new SpvcReflectedResource.Buffer instance allocated with memAlloc.

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

Returns a new SpvcReflectedResource instance allocated on the specified MemoryStack.

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

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

public ByteBuffer
name()

The declared name (OpName) of the resource.

public SpvcReflectedResource
name(ByteBuffer value)

Sets the address of the specified encoded string to the name field.

public String
nameString()

The declared name (OpName) of the resource.

public static int
nbase_type_id(long struct)

Unsafe version of base_type_id.

public static void
nbase_type_id(long struct, int value)

Unsafe version of base_type_id.

public static int
nid(long struct)

Unsafe version of id.

public static void
nid(long struct, int value)

Unsafe version of id.

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 int
ntype_id(long struct)

Unsafe version of type_id.

public static void
ntype_id(long struct, int value)

Unsafe version of type_id.

public SpvcReflectedResource
set(int id, int base_type_id, int type_id, ByteBuffer name)

Initializes this struct with the specified values.

public SpvcReflectedResource

Returns:

this struct
set
(SpvcReflectedResource
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_id()

The type ID of the variable which includes arrays and all type modifications.

public SpvcReflectedResource
type_id(int value)

Sets the specified value to the type_id field.

public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

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.

BASE_TYPE_IDback to summary
public static final int BASE_TYPE_ID

The struct member offsets.

IDback to summary
public static final int ID

The struct member offsets.

NAMEback to summary
public static final int NAME

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TYPE_IDback to summary
public static final int TYPE_ID

The struct member offsets.

Constructor Detail

SpvcReflectedResourceback to summary
protected SpvcReflectedResource(long address, ByteBuffer container)
SpvcReflectedResourceback to summary
public SpvcReflectedResource(ByteBuffer container)

Creates a SpvcReflectedResource 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

base_type_idback to summary
public int base_type_id()

The base type of the declared resource.

This type is the base type which ignores pointers and arrays of the type_id. This is mostly useful to parse decorations of the underlying type. base_type_id can also be obtained with get_type(get_type(type_id).self).

Annotations
@NativeType:spvc_type_id
base_type_idback to summary
public SpvcReflectedResource base_type_id(int value)

Sets the specified value to the base_type_id field.

callocback to summary
public static SpvcReflectedResource calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static SpvcReflectedResource calloc(MemoryStack stack)

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

Returns a new SpvcReflectedResource.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 SpvcReflectedResource 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 SpvcReflectedResource create()

Returns a new SpvcReflectedResource instance allocated with BufferUtils.

createback to summary
public static SpvcReflectedResource create(long address)

Returns a new SpvcReflectedResource instance for the specified memory address.

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

Returns a new SpvcReflectedResource.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a SpvcReflectedResource.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static SpvcReflectedResource createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
idback to summary
public int id()

Resources are identified with their SPIR-V ID. This is the ID of the OpVariable.

Annotations
@NativeType:spvc_variable_id
idback to summary
public SpvcReflectedResource id(int value)

Sets the specified value to the id field.

mallocback to summary
public static SpvcReflectedResource malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static SpvcReflectedResource malloc(MemoryStack stack)

Returns a new SpvcReflectedResource instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nameback to summary
public ByteBuffer name()

The declared name (OpName) of the resource.

For Buffer blocks, the name actually reflects the externally visible Block name. This name can be retrieved again by using either get_name(id) or get_name(base_type_id) depending if it's a buffer block or not. This name can be an empty string in which case get_fallback_name(id) can be used which obtains a suitable fallback identifier for an ID.

Annotations
@NativeType:char const *
nameback to summary
public SpvcReflectedResource name(ByteBuffer value)

Sets the address of the specified encoded string to the name field.

nameStringback to summary
public String nameString()

The declared name (OpName) of the resource.

For Buffer blocks, the name actually reflects the externally visible Block name. This name can be retrieved again by using either get_name(id) or get_name(base_type_id) depending if it's a buffer block or not. This name can be an empty string in which case get_fallback_name(id) can be used which obtains a suitable fallback identifier for an ID.

Annotations
@NativeType:char const *
nbase_type_idback to summary
public static int nbase_type_id(long struct)

Unsafe version of base_type_id.

nbase_type_idback to summary
public static void nbase_type_id(long struct, int value)

Unsafe version of base_type_id.

nidback to summary
public static int nid(long struct)

Unsafe version of id.

nidback to summary
public static void nid(long struct, int value)

Unsafe version of id.

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.

ntype_idback to summary
public static int ntype_id(long struct)

Unsafe version of type_id.

ntype_idback to summary
public static void ntype_id(long struct, int value)

Unsafe version of type_id.

setback to summary
public SpvcReflectedResource set(int id, int base_type_id, int type_id, ByteBuffer name)

Initializes this struct with the specified values.

setback to summary
public SpvcReflectedResource set(SpvcReflectedResource src)

Copies the specified struct data to this struct.

Parameters
src:SpvcReflectedResource

the source struct

Returns:SpvcReflectedResource

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
type_idback to summary
public int type_id()

The type ID of the variable which includes arrays and all type modifications.

This type ID is not suitable for parsing OpMemberDecoration of a struct and other decorations in general since these modifications typically happen on the base_type_id.

Annotations
@NativeType:spvc_type_id
type_idback to summary
public SpvcReflectedResource type_id(int value)

Sets the specified value to the type_id field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.util.spvc back to summary

public Class SpvcReflectedResource.Buffer

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

An array of SpvcReflectedResource structs.

Field Summary

Modifier and TypeField and Description
private static final SpvcReflectedResource

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new SpvcReflectedResource.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 int

Returns:

the value of the SpvcReflectedResource#base_type_id field.
base_type_id
()

public SpvcReflectedResource.Buffer
base_type_id(int value)

Sets the specified value to the SpvcReflectedResource#base_type_id field.

protected SpvcReflectedResource
public int

Returns:

the value of the SpvcReflectedResource#id field.
id
()

public SpvcReflectedResource.Buffer
id(int value)

Sets the specified value to the SpvcReflectedResource#id field.

public ByteBuffer

Returns:

a ByteBuffer view of the null-terminated string pointed to by the SpvcReflectedResource#name field.
name
()

public SpvcReflectedResource.Buffer
name(ByteBuffer value)

Sets the address of the specified encoded string to the SpvcReflectedResource#name field.

public String

Returns:

the null-terminated string pointed to by the SpvcReflectedResource#name field.
nameString
()

protected SpvcReflectedResource.Buffer
public int

Returns:

the value of the SpvcReflectedResource#type_id field.
type_id
()

public SpvcReflectedResource.Buffer
type_id(int value)

Sets the specified value to the SpvcReflectedResource#type_id field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final SpvcReflectedResource ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

base_type_idback to summary
public int base_type_id()
Returns:int

the value of the SpvcReflectedResource#base_type_id field.

Annotations
@NativeType:spvc_type_id
base_type_idback to summary
public SpvcReflectedResource.Buffer base_type_id(int value)

Sets the specified value to the SpvcReflectedResource#base_type_id field.

getElementFactoryback to summary
protected SpvcReflectedResource getElementFactory()

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

Annotations
@Override
idback to summary
public int id()
Returns:int

the value of the SpvcReflectedResource#id field.

Annotations
@NativeType:spvc_variable_id
idback to summary
public SpvcReflectedResource.Buffer id(int value)

Sets the specified value to the SpvcReflectedResource#id field.

nameback to summary
public ByteBuffer name()
Returns:ByteBuffer

a ByteBuffer view of the null-terminated string pointed to by the SpvcReflectedResource#name field.

Annotations
@NativeType:char const *
nameback to summary
public SpvcReflectedResource.Buffer name(ByteBuffer value)

Sets the address of the specified encoded string to the SpvcReflectedResource#name field.

nameStringback to summary
public String nameString()
Returns:String

the null-terminated string pointed to by the SpvcReflectedResource#name field.

Annotations
@NativeType:char const *
selfback to summary
protected SpvcReflectedResource.Buffer self()

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

Annotations
@Override
type_idback to summary
public int type_id()
Returns:int

the value of the SpvcReflectedResource#type_id field.

Annotations
@NativeType:spvc_type_id
type_idback to summary
public SpvcReflectedResource.Buffer type_id(int value)

Sets the specified value to the SpvcReflectedResource#type_id field.