Package org.lwjgl.vulkan

Class VkPipelineBinaryInfoKHR

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkPipelineBinaryInfoKHR>
org.lwjgl.vulkan.VkPipelineBinaryInfoKHR
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkPipelineBinaryInfoKHR extends org.lwjgl.system.Struct<VkPipelineBinaryInfoKHR> implements org.lwjgl.system.NativeResource
Structure specifying pipeline binaries to use during pipeline creation.
Description

If a VkPipelineBinaryInfoKHR structure with a binaryCount greater than 0 is included in the pNext chain of any stext:Vk*PipelineCreateInfo structure when creating a pipeline, implementations must use the data in pPipelineBinaries instead of recalculating it. Any shader module identifiers or shader modules declared in VkPipelineShaderStageCreateInfo instances are ignored.

If this structure is not included in the pNext chain, it is equivalent to specifying this structure with a binaryCount of 0.

Valid Usage
Valid Usage (Implicit)

Layout


 struct VkPipelineBinaryInfoKHR {
     VkStructureType sType();
     void const * pNext();
     uint32_t binaryCount();
     VkPipelineBinaryKHR const * pPipelineBinaries();
 }

  • 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.

    • BINARYCOUNT

      public static final int BINARYCOUNT
      The struct member offsets.

    • PPIPELINEBINARIES

      public static final int PPIPELINEBINARIES
      The struct member offsets.

  • Constructor Details

    • VkPipelineBinaryInfoKHR

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

    • sType

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

    • pNext

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

    • binaryCount

      public int binaryCount()
      the number of elements in the pPipelineBinaries array.

    • pPipelineBinaries

      public @Nullable LongBuffer pPipelineBinaries()
      a pointer to an array of VkPipelineBinaryKHR handles.

    • sType

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

    • sType$Default

      public VkPipelineBinaryInfoKHR sType$Default()
      Sets the STRUCTURE_TYPE_PIPELINE_BINARY_INFO_KHR value to the sType() field.

    • pNext

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

    • pPipelineBinaries

      public VkPipelineBinaryInfoKHR pPipelineBinaries(@Nullable LongBuffer value)
      Sets the address of the specified LongBuffer to the pPipelineBinaries() field.

    • set

      public VkPipelineBinaryInfoKHR set(int sType, long pNext, @Nullable LongBuffer pPipelineBinaries)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nbinaryCount

      public static int nbinaryCount(long struct)
      Unsafe version of binaryCount().

    • npPipelineBinaries

      public static @Nullable LongBuffer npPipelineBinaries(long struct)
      Unsafe version of pPipelineBinaries.

    • 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.

    • nbinaryCount

      public static void nbinaryCount(long struct, int value)
      Sets the specified value to the binaryCount field of the specified struct.

    • npPipelineBinaries

      public static void npPipelineBinaries(long struct, @Nullable LongBuffer value)
      Unsafe version of pPipelineBinaries.

    • validate

      public static void validate(long struct)
      Validates pointer members that should not be NULL.
      Parameters:
      struct - the struct to validate