SpvcReflectedResource (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.util.spvc.SpvcReflectedResource

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class SpvcReflectedResource
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Member documentation
- id – Resources are identified with their SPIR-V ID. This is the ID of the OpVariable.
- 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).
- 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.
- 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.
Layout
```
 struct SpvcReflectedResource {
     spvc_variable_id id;
     spvc_type_id base_type_id;
     spvc_type_id type_id;
     char const * name;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SpvcReflectedResource.Buffer
An array of SpvcReflectedResource structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`SpvcReflectedResource.Buffer` An array of `SpvcReflectedResource` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`BASE_TYPE_ID` The struct member offsets.
`static int`	`ID` The struct member offsets.
`static int`	`NAME` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`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 and Description
`SpvcReflectedResource(java.nio.ByteBuffer container)` Creates a `SpvcReflectedResource` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`base_type_id()` Returns the value of the `base_type_id` field.
`SpvcReflectedResource`	`base_type_id(int value)` Sets the specified value to the `base_type_id` field.
`static SpvcReflectedResource`	`calloc()` Returns a new `SpvcReflectedResource` instance allocated with `memCalloc`.
`static SpvcReflectedResource.Buffer`	`calloc(int capacity)` Returns a new `SpvcReflectedResource.Buffer` instance allocated with `memCalloc`.
`static SpvcReflectedResource`	`callocStack()` Returns a new `SpvcReflectedResource` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static SpvcReflectedResource.Buffer`	`callocStack(int capacity)` Returns a new `SpvcReflectedResource.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static SpvcReflectedResource.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `SpvcReflectedResource.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static SpvcReflectedResource`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `SpvcReflectedResource` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static SpvcReflectedResource`	`create()` Returns a new `SpvcReflectedResource` instance allocated with `BufferUtils`.
`static SpvcReflectedResource.Buffer`	`create(int capacity)` Returns a new `SpvcReflectedResource.Buffer` instance allocated with `BufferUtils`.
`static SpvcReflectedResource`	`create(long address)` Returns a new `SpvcReflectedResource` instance for the specified memory address.
`static SpvcReflectedResource.Buffer`	`create(long address, int capacity)` Create a `SpvcReflectedResource.Buffer` instance at the specified memory.
`static SpvcReflectedResource`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static SpvcReflectedResource.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`id()` Returns the value of the `id` field.
`SpvcReflectedResource`	`id(int value)` Sets the specified value to the `id` field.
`static SpvcReflectedResource`	`malloc()` Returns a new `SpvcReflectedResource` instance allocated with `memAlloc`.
`static SpvcReflectedResource.Buffer`	`malloc(int capacity)` Returns a new `SpvcReflectedResource.Buffer` instance allocated with `memAlloc`.
`static SpvcReflectedResource`	`mallocStack()` Returns a new `SpvcReflectedResource` instance allocated on the thread-local `MemoryStack`.
`static SpvcReflectedResource.Buffer`	`mallocStack(int capacity)` Returns a new `SpvcReflectedResource.Buffer` instance allocated on the thread-local `MemoryStack`.
`static SpvcReflectedResource.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `SpvcReflectedResource.Buffer` instance allocated on the specified `MemoryStack`.
`static SpvcReflectedResource`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `SpvcReflectedResource` instance allocated on the specified `MemoryStack`.
`java.nio.ByteBuffer`	`name()` Returns a `ByteBuffer` view of the null-terminated string pointed to by the `name` field.
`SpvcReflectedResource`	`name(java.nio.ByteBuffer value)` Sets the address of the specified encoded string to the `name` field.
`java.lang.String`	`nameString()` Decodes the null-terminated string pointed to by the `name` field.
`static int`	`nbase_type_id(long struct)` Unsafe version of `base_type_id()`.
`static void`	`nbase_type_id(long struct, int value)` Unsafe version of `base_type_id`.
`static int`	`nid(long struct)` Unsafe version of `id()`.
`static void`	`nid(long struct, int value)` Unsafe version of `id`.
`static java.nio.ByteBuffer`	`nname(long struct)` Unsafe version of `name()`.
`static void`	`nname(long struct, java.nio.ByteBuffer value)` Unsafe version of `name`.
`static java.lang.String`	`nnameString(long struct)` Unsafe version of `nameString()`.
`static int`	`ntype_id(long struct)` Unsafe version of `type_id()`.
`static void`	`ntype_id(long struct, int value)` Unsafe version of `type_id`.
`SpvcReflectedResource`	`set(int id, int base_type_id, int type_id, java.nio.ByteBuffer name)` Initializes this struct with the specified values.
`SpvcReflectedResource`	`set(SpvcReflectedResource src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`type_id()` Returns the value of the `type_id` field.
`SpvcReflectedResource`	`type_id(int value)` Sets the specified value to the `type_id` field.
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

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 Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - ID
```
public static final int ID
```
    The struct member offsets.
  - BASE_TYPE_ID
```
public static final int BASE_TYPE_ID
```
    The struct member offsets.
  - TYPE_ID
```
public static final int TYPE_ID
```
    The struct member offsets.
  - NAME
```
public static final int NAME
```
    The struct member offsets.
- Constructor Detail
  - SpvcReflectedResource
```
public SpvcReflectedResource(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - id
```
public int id()
```
    Returns the value of the id field.
  - base_type_id
```
public int base_type_id()
```
    Returns the value of the base_type_id field.
  - type_id
```
public int type_id()
```
    Returns the value of the type_id field.
  - name
```
public java.nio.ByteBuffer name()
```
    Returns a ByteBuffer view of the null-terminated string pointed to by the name field.
  - nameString
```
public java.lang.String nameString()
```
    Decodes the null-terminated string pointed to by the name field.
  - id
```
public SpvcReflectedResource id(int value)
```
    Sets the specified value to the id field.
  - base_type_id
```
public SpvcReflectedResource base_type_id(int value)
```
    Sets the specified value to the base_type_id field.
  - type_id
```
public SpvcReflectedResource type_id(int value)
```
    Sets the specified value to the type_id field.
  - name
```
public SpvcReflectedResource name(java.nio.ByteBuffer value)
```
    Sets the address of the specified encoded string to the name field.
  - set
```
public SpvcReflectedResource set(int id,
                                 int base_type_id,
                                 int type_id,
                                 java.nio.ByteBuffer name)
```
    Initializes this struct with the specified values.
  - set
```
public SpvcReflectedResource set(SpvcReflectedResource src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static SpvcReflectedResource malloc()
```
    Returns a new SpvcReflectedResource instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static SpvcReflectedResource calloc()
```
    Returns a new SpvcReflectedResource instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static SpvcReflectedResource create()
```
    Returns a new SpvcReflectedResource instance allocated with BufferUtils.
  - create
```
public static SpvcReflectedResource create(long address)
```
    Returns a new SpvcReflectedResource instance for the specified memory address.
  - createSafe
```
@Nullable
public static SpvcReflectedResource createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static SpvcReflectedResource.Buffer malloc(int capacity)
```
    Returns a new SpvcReflectedResource.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static SpvcReflectedResource.Buffer calloc(int capacity)
```
    Returns a new SpvcReflectedResource.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static SpvcReflectedResource.Buffer create(int capacity)
```
    Returns a new SpvcReflectedResource.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static SpvcReflectedResource.Buffer create(long address,
                                                  int capacity)
```
    Create a SpvcReflectedResource.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static SpvcReflectedResource.Buffer createSafe(long address,
                                                                int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static SpvcReflectedResource mallocStack()
```
    Returns a new SpvcReflectedResource instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static SpvcReflectedResource callocStack()
```
    Returns a new SpvcReflectedResource instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static SpvcReflectedResource mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new SpvcReflectedResource instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static SpvcReflectedResource callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new SpvcReflectedResource instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static SpvcReflectedResource.Buffer mallocStack(int capacity)
```
    Returns a new SpvcReflectedResource.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static SpvcReflectedResource.Buffer callocStack(int capacity)
```
    Returns a new SpvcReflectedResource.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static SpvcReflectedResource.Buffer mallocStack(int capacity,
                                                       org.lwjgl.system.MemoryStack stack)
```
    Returns a new SpvcReflectedResource.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static SpvcReflectedResource.Buffer callocStack(int capacity,
                                                       org.lwjgl.system.MemoryStack stack)
```
    Returns a new SpvcReflectedResource.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nid
```
public static int nid(long struct)
```
    Unsafe version of id().
  - nbase_type_id
```
public static int nbase_type_id(long struct)
```
    Unsafe version of base_type_id().
  - ntype_id
```
public static int ntype_id(long struct)
```
    Unsafe version of type_id().
  - nname
```
public static java.nio.ByteBuffer nname(long struct)
```
    Unsafe version of name().
  - nnameString
```
public static java.lang.String nnameString(long struct)
```
    Unsafe version of nameString().
  - nid
```
public static void nid(long struct,
                       int value)
```
    Unsafe version of id.
  - nbase_type_id
```
public static void nbase_type_id(long struct,
                                 int value)
```
    Unsafe version of base_type_id.
  - ntype_id
```
public static void ntype_id(long struct,
                            int value)
```
    Unsafe version of type_id.
  - nname
```
public static void nname(long struct,
                         java.nio.ByteBuffer value)
```
    Unsafe version of name.
  - validate
```
public static void validate(long struct)
```
    Validates pointer members that should not be NULL.
    
    Parameters:
    
    struct - the struct to validate
  - validate
```
public static void validate(long array,
                            int count)
```
    Calls validate(long) for each struct contained in the specified struct array.
    
    Parameters:
    
    array - the struct array to validate
    
    count - the number of structs in array

Class SpvcReflectedResource

Member documentation

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

ID

BASE_TYPE_ID

TYPE_ID

NAME

Constructor Detail

SpvcReflectedResource

Method Detail

sizeof

id

base_type_id

type_id

name

nameString

id

base_type_id

type_id

name

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nid

nbase_type_id

ntype_id

nname

nnameString

nid

nbase_type_id

ntype_id

nname

validate

validate