Package org.lwjgl.vulkan

Class VkPushDescriptorSetInfo

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkPushDescriptorSetInfo>
org.lwjgl.vulkan.VkPushDescriptorSetInfo
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
Direct Known Subclasses:
VkPushDescriptorSetInfoKHR
public class VkPushDescriptorSetInfo extends org.lwjgl.system.Struct<VkPushDescriptorSetInfo> implements org.lwjgl.system.NativeResource
Structure specifying a descriptor set push operation.
Description

If stageFlags specifies a subset of all stages corresponding to one or more pipeline bind points, the binding operation still affects all stages corresponding to the given pipeline bind point(s) as if the equivalent original version of this command had been called with the same parameters. For example, specifying a stageFlags value of SHADER_STAGE_VERTEX_BIT | SHADER_STAGE_FRAGMENT_BIT | SHADER_STAGE_COMPUTE_BIT is equivalent to calling the original version of this command once with PIPELINE_BIND_POINT_GRAPHICS and once with PIPELINE_BIND_POINT_COMPUTE.

Valid Usage
Valid Usage (Implicit)
  • sType must be STRUCTURE_TYPE_PUSH_DESCRIPTOR_SET_INFO
  • pNext must be NULL or a pointer to a valid instance of VkPipelineLayoutCreateInfo
  • The sType value of each struct in the pNext chain must be unique
  • stageFlags must be a valid combination of VkShaderStageFlagBits values
  • stageFlags must not be 0
  • If layout is not NULL_HANDLE, layout must be a valid VkPipelineLayout handle
  • pDescriptorWrites must be a valid pointer to an array of descriptorWriteCount valid VkWriteDescriptorSet structures
  • descriptorWriteCount must be greater than 0
See Also

VkWriteDescriptorSet, CmdPushDescriptorSet2, CmdPushDescriptorSet2KHR

Layout


 struct VkPushDescriptorSetInfo {
     VkStructureType sType();
     void const * pNext();
     VkShaderStageFlags stageFlags();
     VkPipelineLayout layout();
     uint32_t set();
     uint32_t descriptorWriteCount();
     VkWriteDescriptorSet const * pDescriptorWrites();
 }

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

    • STAGEFLAGS

      public static final int STAGEFLAGS
      The struct member offsets.

    • LAYOUT

      public static final int LAYOUT
      The struct member offsets.

    • SET

      public static final int SET
      The struct member offsets.

    • DESCRIPTORWRITECOUNT

      public static final int DESCRIPTORWRITECOUNT
      The struct member offsets.

    • PDESCRIPTORWRITES

      public static final int PDESCRIPTORWRITES
      The struct member offsets.

  • Constructor Details

    • VkPushDescriptorSetInfo

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

    • sType

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

    • pNext

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

    • stageFlags

      public int stageFlags()
      a bitmask of VkShaderStageFlagBits specifying the shader stages that will use the descriptors.

    • layout

      public long layout()
      a VkPipelineLayout object used to program the bindings. If the dynamicPipelineLayout feature is enabled, layout can be NULL_HANDLE and the layout must be specified by chaining VkPipelineLayoutCreateInfo structure off the pNext

    • set

      public int set()
      the set number of the descriptor set in the pipeline layout that will be updated.

    • descriptorWriteCount

      public int descriptorWriteCount()
      the number of elements in the pDescriptorWrites array.

    • pDescriptorWrites

      public VkWriteDescriptorSet.Buffer pDescriptorWrites()
      a pointer to an array of VkWriteDescriptorSet structures describing the descriptors to be updated.

    • sType

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

    • sType$Default

      public VkPushDescriptorSetInfo sType$Default()
      Sets the STRUCTURE_TYPE_PUSH_DESCRIPTOR_SET_INFO value to the sType() field.

    • pNext

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

    • pNext

      public VkPushDescriptorSetInfo pNext(VkPipelineLayoutCreateInfo value)
      Prepends the specified VkPipelineLayoutCreateInfo value to the pNext chain.

    • stageFlags

      public VkPushDescriptorSetInfo stageFlags(int value)
      Sets the specified value to the stageFlags() field.

    • layout

      public VkPushDescriptorSetInfo layout(long value)
      Sets the specified value to the layout() field.

    • set

      public VkPushDescriptorSetInfo set(int value)
      Sets the specified value to the set() field.

    • pDescriptorWrites

      public VkPushDescriptorSetInfo pDescriptorWrites(VkWriteDescriptorSet.Buffer value)
      Sets the address of the specified VkWriteDescriptorSet.Buffer to the pDescriptorWrites() field.

    • set

      public VkPushDescriptorSetInfo set(int sType, long pNext, int stageFlags, long layout, int set, VkWriteDescriptorSet.Buffer pDescriptorWrites)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nstageFlags

      public static int nstageFlags(long struct)
      Unsafe version of stageFlags().

    • nlayout

      public static long nlayout(long struct)
      Unsafe version of layout().

    • nset

      public static int nset(long struct)
      Unsafe version of set().

    • ndescriptorWriteCount

      public static int ndescriptorWriteCount(long struct)
      Unsafe version of descriptorWriteCount().

    • npDescriptorWrites

      public static VkWriteDescriptorSet.Buffer npDescriptorWrites(long struct)
      Unsafe version of pDescriptorWrites().

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

    • nstageFlags

      public static void nstageFlags(long struct, int value)
      Unsafe version of stageFlags.

    • nlayout

      public static void nlayout(long struct, long value)
      Unsafe version of layout.

    • nset

      public static void nset(long struct, int value)
      Unsafe version of set.

    • ndescriptorWriteCount

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

    • npDescriptorWrites

      public static void npDescriptorWrites(long struct, VkWriteDescriptorSet.Buffer value)
      Unsafe version of pDescriptorWrites.

    • validate

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