SpvcMslResourceBinding (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class SpvcMslResourceBinding
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Matches the binding index of a MSL resource for a binding within a descriptor set.
Taken together, the stage, desc_set and binding combine to form a reference to a resource descriptor used in a particular shading stage. If using MSL 2.0 argument buffers, the descriptor set is not marked as a discrete descriptor set, and (for iOS only) the resource is not a storage image (sampled != 2), the binding reference we remap to will become an [[id(N)]] attribute within the "descriptor set" argument buffer structure. For resources which are bound in the "classic" MSL 1.0 way or discrete descriptors, the remap will become a [[buffer(N)]], [[texture(N)]] or [[sampler(N)]] depending on the resource types used.

Layout
```
 struct SpvcMslResourceBinding {
     SpvExecutionModel stage;
     unsigned int desc_set;
     unsigned int binding;
     unsigned int msl_buffer;
     unsigned int msl_texture;
     unsigned int msl_sampler;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SpvcMslResourceBinding.Buffer
An array of SpvcMslResourceBinding 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`	`SpvcMslResourceBinding.Buffer` An array of `SpvcMslResourceBinding` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`BINDING` The struct member offsets.
`static int`	`DESC_SET` The struct member offsets.
`static int`	`MSL_BUFFER` The struct member offsets.
`static int`	`MSL_SAMPLER` The struct member offsets.
`static int`	`MSL_TEXTURE` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STAGE` 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
`SpvcMslResourceBinding(java.nio.ByteBuffer container)` Creates a `SpvcMslResourceBinding` 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`	`binding()` Returns the value of the `binding` field.
`SpvcMslResourceBinding`	`binding(int value)` Sets the specified value to the `binding` field.
`static SpvcMslResourceBinding`	`calloc()` Returns a new `SpvcMslResourceBinding` instance allocated with `memCalloc`.
`static SpvcMslResourceBinding.Buffer`	`calloc(int capacity)` Returns a new `SpvcMslResourceBinding.Buffer` instance allocated with `memCalloc`.
`static SpvcMslResourceBinding`	`callocStack()` Returns a new `SpvcMslResourceBinding` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static SpvcMslResourceBinding.Buffer`	`callocStack(int capacity)` Returns a new `SpvcMslResourceBinding.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static SpvcMslResourceBinding.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `SpvcMslResourceBinding.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static SpvcMslResourceBinding`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `SpvcMslResourceBinding` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static SpvcMslResourceBinding`	`create()` Returns a new `SpvcMslResourceBinding` instance allocated with `BufferUtils`.
`static SpvcMslResourceBinding.Buffer`	`create(int capacity)` Returns a new `SpvcMslResourceBinding.Buffer` instance allocated with `BufferUtils`.
`static SpvcMslResourceBinding`	`create(long address)` Returns a new `SpvcMslResourceBinding` instance for the specified memory address.
`static SpvcMslResourceBinding.Buffer`	`create(long address, int capacity)` Create a `SpvcMslResourceBinding.Buffer` instance at the specified memory.
`static SpvcMslResourceBinding`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static SpvcMslResourceBinding.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`desc_set()` Returns the value of the `desc_set` field.
`SpvcMslResourceBinding`	`desc_set(int value)` Sets the specified value to the `desc_set` field.
`static SpvcMslResourceBinding`	`malloc()` Returns a new `SpvcMslResourceBinding` instance allocated with `memAlloc`.
`static SpvcMslResourceBinding.Buffer`	`malloc(int capacity)` Returns a new `SpvcMslResourceBinding.Buffer` instance allocated with `memAlloc`.
`static SpvcMslResourceBinding`	`mallocStack()` Returns a new `SpvcMslResourceBinding` instance allocated on the thread-local `MemoryStack`.
`static SpvcMslResourceBinding.Buffer`	`mallocStack(int capacity)` Returns a new `SpvcMslResourceBinding.Buffer` instance allocated on the thread-local `MemoryStack`.
`static SpvcMslResourceBinding.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `SpvcMslResourceBinding.Buffer` instance allocated on the specified `MemoryStack`.
`static SpvcMslResourceBinding`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `SpvcMslResourceBinding` instance allocated on the specified `MemoryStack`.
`int`	`msl_buffer()` Returns the value of the `msl_buffer` field.
`SpvcMslResourceBinding`	`msl_buffer(int value)` Sets the specified value to the `msl_buffer` field.
`int`	`msl_sampler()` Returns the value of the `msl_sampler` field.
`SpvcMslResourceBinding`	`msl_sampler(int value)` Sets the specified value to the `msl_sampler` field.
`int`	`msl_texture()` Returns the value of the `msl_texture` field.
`SpvcMslResourceBinding`	`msl_texture(int value)` Sets the specified value to the `msl_texture` field.
`static int`	`nbinding(long struct)` Unsafe version of `binding()`.
`static void`	`nbinding(long struct, int value)` Unsafe version of `binding`.
`static int`	`ndesc_set(long struct)` Unsafe version of `desc_set()`.
`static void`	`ndesc_set(long struct, int value)` Unsafe version of `desc_set`.
`static int`	`nmsl_buffer(long struct)` Unsafe version of `msl_buffer()`.
`static void`	`nmsl_buffer(long struct, int value)` Unsafe version of `msl_buffer`.
`static int`	`nmsl_sampler(long struct)` Unsafe version of `msl_sampler()`.
`static void`	`nmsl_sampler(long struct, int value)` Unsafe version of `msl_sampler`.
`static int`	`nmsl_texture(long struct)` Unsafe version of `msl_texture()`.
`static void`	`nmsl_texture(long struct, int value)` Unsafe version of `msl_texture`.
`static int`	`nstage(long struct)` Unsafe version of `stage()`.
`static void`	`nstage(long struct, int value)` Unsafe version of `stage`.
`SpvcMslResourceBinding`	`set(int stage, int desc_set, int binding, int msl_buffer, int msl_texture, int msl_sampler)` Initializes this struct with the specified values.
`SpvcMslResourceBinding`	`set(SpvcMslResourceBinding src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`stage()` Returns the value of the `stage` field.
`SpvcMslResourceBinding`	`stage(int value)` Sets the specified value to the `stage` field.

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.
  - STAGE
```
public static final int STAGE
```
    The struct member offsets.
  - DESC_SET
```
public static final int DESC_SET
```
    The struct member offsets.
  - BINDING
```
public static final int BINDING
```
    The struct member offsets.
  - MSL_BUFFER
```
public static final int MSL_BUFFER
```
    The struct member offsets.
  - MSL_TEXTURE
```
public static final int MSL_TEXTURE
```
    The struct member offsets.
  - MSL_SAMPLER
```
public static final int MSL_SAMPLER
```
    The struct member offsets.
- Constructor Detail
  - SpvcMslResourceBinding
```
public SpvcMslResourceBinding(java.nio.ByteBuffer container)
```
    Creates a SpvcMslResourceBinding 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
  - stage
```
public int stage()
```
    Returns the value of the stage field.
  - desc_set
```
public int desc_set()
```
    Returns the value of the desc_set field.
  - binding
```
public int binding()
```
    Returns the value of the binding field.
  - msl_buffer
```
public int msl_buffer()
```
    Returns the value of the msl_buffer field.
  - msl_texture
```
public int msl_texture()
```
    Returns the value of the msl_texture field.
  - msl_sampler
```
public int msl_sampler()
```
    Returns the value of the msl_sampler field.
  - stage
```
public SpvcMslResourceBinding stage(int value)
```
    Sets the specified value to the stage field.
  - desc_set
```
public SpvcMslResourceBinding desc_set(int value)
```
    Sets the specified value to the desc_set field.
  - binding
```
public SpvcMslResourceBinding binding(int value)
```
    Sets the specified value to the binding field.
  - msl_buffer
```
public SpvcMslResourceBinding msl_buffer(int value)
```
    Sets the specified value to the msl_buffer field.
  - msl_texture
```
public SpvcMslResourceBinding msl_texture(int value)
```
    Sets the specified value to the msl_texture field.
  - msl_sampler
```
public SpvcMslResourceBinding msl_sampler(int value)
```
    Sets the specified value to the msl_sampler field.
  - set
```
public SpvcMslResourceBinding set(int stage,
                                  int desc_set,
                                  int binding,
                                  int msl_buffer,
                                  int msl_texture,
                                  int msl_sampler)
```
    Initializes this struct with the specified values.
  - set
```
public SpvcMslResourceBinding set(SpvcMslResourceBinding src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static SpvcMslResourceBinding malloc()
```
    Returns a new SpvcMslResourceBinding instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static SpvcMslResourceBinding calloc()
```
    Returns a new SpvcMslResourceBinding instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static SpvcMslResourceBinding create()
```
    Returns a new SpvcMslResourceBinding instance allocated with BufferUtils.
  - create
```
public static SpvcMslResourceBinding create(long address)
```
    Returns a new SpvcMslResourceBinding instance for the specified memory address.
  - createSafe
```
@Nullable
public static SpvcMslResourceBinding createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static SpvcMslResourceBinding.Buffer malloc(int capacity)
```
    Returns a new SpvcMslResourceBinding.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static SpvcMslResourceBinding.Buffer calloc(int capacity)
```
    Returns a new SpvcMslResourceBinding.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static SpvcMslResourceBinding.Buffer create(int capacity)
```
    Returns a new SpvcMslResourceBinding.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static SpvcMslResourceBinding.Buffer create(long address,
                                                   int capacity)
```
    Create a SpvcMslResourceBinding.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static SpvcMslResourceBinding.Buffer createSafe(long address,
                                                                 int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static SpvcMslResourceBinding mallocStack()
```
    Returns a new SpvcMslResourceBinding instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static SpvcMslResourceBinding callocStack()
```
    Returns a new SpvcMslResourceBinding instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static SpvcMslResourceBinding mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new SpvcMslResourceBinding instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static SpvcMslResourceBinding callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new SpvcMslResourceBinding instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static SpvcMslResourceBinding.Buffer mallocStack(int capacity)
```
    Returns a new SpvcMslResourceBinding.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static SpvcMslResourceBinding.Buffer callocStack(int capacity)
```
    Returns a new SpvcMslResourceBinding.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static SpvcMslResourceBinding.Buffer mallocStack(int capacity,
                                                        org.lwjgl.system.MemoryStack stack)
```
    Returns a new SpvcMslResourceBinding.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static SpvcMslResourceBinding.Buffer callocStack(int capacity,
                                                        org.lwjgl.system.MemoryStack stack)
```
    Returns a new SpvcMslResourceBinding.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
  - nstage
```
public static int nstage(long struct)
```
    Unsafe version of stage().
  - ndesc_set
```
public static int ndesc_set(long struct)
```
    Unsafe version of desc_set().
  - nbinding
```
public static int nbinding(long struct)
```
    Unsafe version of binding().
  - nmsl_buffer
```
public static int nmsl_buffer(long struct)
```
    Unsafe version of msl_buffer().
  - nmsl_texture
```
public static int nmsl_texture(long struct)
```
    Unsafe version of msl_texture().
  - nmsl_sampler
```
public static int nmsl_sampler(long struct)
```
    Unsafe version of msl_sampler().
  - nstage
```
public static void nstage(long struct,
                          int value)
```
    Unsafe version of stage.
  - ndesc_set
```
public static void ndesc_set(long struct,
                             int value)
```
    Unsafe version of desc_set.
  - nbinding
```
public static void nbinding(long struct,
                            int value)
```
    Unsafe version of binding.
  - nmsl_buffer
```
public static void nmsl_buffer(long struct,
                               int value)
```
    Unsafe version of msl_buffer.
  - nmsl_texture
```
public static void nmsl_texture(long struct,
                                int value)
```
    Unsafe version of msl_texture.
  - nmsl_sampler
```
public static void nmsl_sampler(long struct,
                                int value)
```
    Unsafe version of msl_sampler.

Class SpvcMslResourceBinding

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

STAGE

DESC_SET

BINDING

MSL_BUFFER

MSL_TEXTURE

MSL_SAMPLER

Constructor Detail

SpvcMslResourceBinding

Method Detail

sizeof

stage

desc_set

binding

msl_buffer

msl_texture

msl_sampler

stage

desc_set

binding

msl_buffer

msl_texture

msl_sampler

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nstage

ndesc_set

nbinding

nmsl_buffer

nmsl_texture

nmsl_sampler

nstage

ndesc_set

nbinding

nmsl_buffer

nmsl_texture

nmsl_sampler