Package org.lwjgl.vulkan

Class VkCheckpointDataNV

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
    public class VkCheckpointDataNV
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
    Return structure for command buffer checkpoint data.
    Description

    The stages at which a checkpoint marker can be executed are implementation-defined and can be queried by calling GetPhysicalDeviceQueueFamilyProperties2.

    Valid Usage (Implicit)
    See Also

    GetQueueCheckpointDataNV

    Layout

    
 struct VkCheckpointDataNV {
     VkStructureType sType();
     void * pNext();
     VkPipelineStageFlagBits stage();
     void * pCheckpointMarker();
 }

    • Field Detail

      • SIZEOF

        The struct size in bytes.

      • ALIGNOF

        The struct alignment in bytes.

      • STYPE, PNEXT, STAGE, PCHECKPOINTMARKER

        The struct member offsets.

    • Constructor Detail

      • VkCheckpointDataNV

        public VkCheckpointDataNV​(java.nio.ByteBuffer container)
        Creates a VkCheckpointDataNV 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

      • sType

        public int sType()
        the type of this structure.

      • pNext

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

      • stage

        public int stage()
        a VkPipelineStageFlagBits value specifying which pipeline stage the checkpoint marker data refers to.

      • pCheckpointMarker

        public long pCheckpointMarker()
        contains the value of the last checkpoint marker executed in the stage that stage refers to.

      • set

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

      • malloc

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

      • calloc

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

      • create

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

      • create

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

      • createSafe

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

      • createSafe

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

      • mallocStack

        @Deprecated
public static VkCheckpointDataNV mallocStack​(org.lwjgl.system.MemoryStack stack)
        Deprecated.
        Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

      • callocStack

        @Deprecated
public static VkCheckpointDataNV callocStack​(org.lwjgl.system.MemoryStack stack)
        Deprecated.
        Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

      • malloc

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

      • calloc

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

      • malloc

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

      • calloc

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

      • nsType

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

      • npNext

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

      • nstage

        public static int nstage​(long struct)
        Unsafe version of stage().

      • npCheckpointMarker

        public static long npCheckpointMarker​(long struct)
        Unsafe version of pCheckpointMarker().

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