Package org.lwjgl.vulkan

Class VkShaderModuleIdentifierEXT

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkShaderModuleIdentifierEXT>
org.lwjgl.vulkan.VkShaderModuleIdentifierEXT
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkShaderModuleIdentifierEXT extends org.lwjgl.system.Struct<VkShaderModuleIdentifierEXT> implements org.lwjgl.system.NativeResource
A unique identifier for a shader module.
Description

Any returned values beyond the first identifierSize bytes are undefined. Implementations must return an identifierSize greater than 0, and less-or-equal to MAX_SHADER_MODULE_IDENTIFIER_SIZE_EXT.

Two identifiers are considered equal if identifierSize is equal and the first identifierSize bytes of identifier compare equal.

Implementations may return a different identifierSize for different modules. Implementations should ensure that identifierSize is large enough to uniquely define a shader module.

Valid Usage (Implicit)
See Also

GetShaderModuleCreateInfoIdentifierEXT, GetShaderModuleIdentifierEXT

Layout


 struct VkShaderModuleIdentifierEXT {
     VkStructureType sType();
     void * pNext();
     uint32_t identifierSize();
     uint8_t identifier()[VK_MAX_SHADER_MODULE_IDENTIFIER_SIZE_EXT];
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • STYPE

      public static final int STYPE
      The struct member offsets.

    • PNEXT

      public static final int PNEXT
      The struct member offsets.

    • IDENTIFIERSIZE

      public static final int IDENTIFIERSIZE
      The struct member offsets.

    • IDENTIFIER

      public static final int IDENTIFIER
      The struct member offsets.

  • Constructor Details

    • VkShaderModuleIdentifierEXT

      public VkShaderModuleIdentifierEXT(ByteBuffer container)
      Creates a VkShaderModuleIdentifierEXT 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<VkShaderModuleIdentifierEXT>

    • sType

      public int sType()
      a VkStructureType value identifying this structure.

    • pNext

      public long pNext()
      NULL or a pointer to a structure extending this structure.

    • identifierSize

      public int identifierSize()
      the size, in bytes, of valid data returned in identifier.

    • identifier

      public ByteBuffer identifier()
      a buffer of opaque data specifying an identifier.

    • identifier

      public byte identifier(int index)
      a buffer of opaque data specifying an identifier.

    • sType

      public VkShaderModuleIdentifierEXT sType(int value)
      Sets the specified value to the sType() field.

    • sType$Default

      public VkShaderModuleIdentifierEXT sType$Default()
      Sets the STRUCTURE_TYPE_SHADER_MODULE_IDENTIFIER_EXT value to the sType() field.

    • pNext

      public VkShaderModuleIdentifierEXT pNext(long value)
      Sets the specified value to the pNext() field.

    • set

      public VkShaderModuleIdentifierEXT set(int sType, long pNext)
      Initializes this struct with the specified values.

    • set

      public VkShaderModuleIdentifierEXT set(VkShaderModuleIdentifierEXT src)
      Copies the specified struct data to this struct.
      Parameters:
      src - the source struct
      Returns:
      this struct

    • malloc

      public static VkShaderModuleIdentifierEXT malloc()
      Returns a new VkShaderModuleIdentifierEXT instance allocated with memAlloc. The instance must be explicitly freed.

    • calloc

      public static VkShaderModuleIdentifierEXT calloc()
      Returns a new VkShaderModuleIdentifierEXT instance allocated with memCalloc. The instance must be explicitly freed.

    • create

      public static VkShaderModuleIdentifierEXT create()
      Returns a new VkShaderModuleIdentifierEXT instance allocated with BufferUtils.

    • create

      public static VkShaderModuleIdentifierEXT create(long address)
      Returns a new VkShaderModuleIdentifierEXT instance for the specified memory address.

    • createSafe

      public static @Nullable VkShaderModuleIdentifierEXT createSafe(long address)
      Like create, but returns null if address is NULL.

    • malloc

      public static VkShaderModuleIdentifierEXT.Buffer malloc(int capacity)
      Returns a new VkShaderModuleIdentifierEXT.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • calloc

      public static VkShaderModuleIdentifierEXT.Buffer calloc(int capacity)
      Returns a new VkShaderModuleIdentifierEXT.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VkShaderModuleIdentifierEXT.Buffer create(int capacity)
      Returns a new VkShaderModuleIdentifierEXT.Buffer instance allocated with BufferUtils.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VkShaderModuleIdentifierEXT.Buffer create(long address, int capacity)
      Create a VkShaderModuleIdentifierEXT.Buffer instance at the specified memory.
      Parameters:
      address - the memory address
      capacity - the buffer capacity

    • createSafe

      public static @Nullable VkShaderModuleIdentifierEXT.Buffer createSafe(long address, int capacity)
      Like create, but returns null if address is NULL.

    • malloc

      public static VkShaderModuleIdentifierEXT malloc(org.lwjgl.system.MemoryStack stack)
      Returns a new VkShaderModuleIdentifierEXT instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate

    • calloc

      public static VkShaderModuleIdentifierEXT calloc(org.lwjgl.system.MemoryStack stack)
      Returns a new VkShaderModuleIdentifierEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      stack - the stack from which to allocate

    • malloc

      public static VkShaderModuleIdentifierEXT.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new VkShaderModuleIdentifierEXT.Buffer instance allocated on the specified MemoryStack.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • calloc

      public static VkShaderModuleIdentifierEXT.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new VkShaderModuleIdentifierEXT.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

    • nsType

      public static int nsType(long struct)
      Unsafe version of sType().

    • npNext

      public static long npNext(long struct)
      Unsafe version of pNext().

    • nidentifierSize

      public static int nidentifierSize(long struct)
      Unsafe version of identifierSize().

    • nidentifier

      public static ByteBuffer nidentifier(long struct)
      Unsafe version of identifier().

    • nidentifier

      public static byte nidentifier(long struct, int index)
      Unsafe version of identifier.

    • nsType

      public static void nsType(long struct, int value)
      Unsafe version of sType.

    • npNext

      public static void npNext(long struct, long value)
      Unsafe version of pNext.