Class VkProtectedSubmitInfo

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

    public class VkProtectedSubmitInfo
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Structure indicating whether the submission is protected.
    Valid Usage
    • If the protected memory feature is not enabled, protectedSubmit must not be TRUE.
    • If protectedSubmit is TRUE, then each element of the pCommandBuffers array must be a protected command buffer.
    • If protectedSubmit is FALSE, then each element of the pCommandBuffers array must be an unprotected command buffer.
    • If the VkSubmitInfo::pNext chain does not include a VkProtectedSubmitInfo structure, then each element of the command buffer of the pCommandBuffers array must be an unprotected command buffer.
    Valid Usage (Implicit)

    Member documentation

    • protectedSubmit – specifies whether the batch is protected. If protectedSubmit is TRUE, the batch is protected. If protectedSubmit is FALSE, the batch is unprotected. If the VkSubmitInfo::pNext chain does not contain this structure, the batch is unprotected.

    Layout

    
     struct VkProtectedSubmitInfo {
         VkStructureType sType;
         void const * pNext;
         VkBool32 protectedSubmit;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, PROTECTEDSUBMIT

        The struct member offsets.
    • Constructor Detail

      • VkProtectedSubmitInfo

        public VkProtectedSubmitInfo​(java.nio.ByteBuffer container)
        Creates a VkProtectedSubmitInfo 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()
        Returns the value of the sType field.
      • pNext

        public long pNext()
        Returns the value of the pNext field.
      • protectedSubmit

        public boolean protectedSubmit()
        Returns the value of the protectedSubmit field.
      • pNext

        public VkProtectedSubmitInfo pNext​(long value)
        Sets the specified value to the pNext field.
      • protectedSubmit

        public VkProtectedSubmitInfo protectedSubmit​(boolean value)
        Sets the specified value to the protectedSubmit field.
      • set

        public VkProtectedSubmitInfo set​(int sType,
                                         long pNext,
                                         boolean protectedSubmit)
        Initializes this struct with the specified values.
      • malloc

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

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

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

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

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

        public static VkProtectedSubmitInfo mallocStack()
        Returns a new VkProtectedSubmitInfo instance allocated on the thread-local MemoryStack.
      • callocStack

        public static VkProtectedSubmitInfo callocStack()
        Returns a new VkProtectedSubmitInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
      • mallocStack

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

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

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

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

        public static int nprotectedSubmit​(long struct)
        Unsafe version of protectedSubmit().
      • 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.
      • nprotectedSubmit

        public static void nprotectedSubmit​(long struct,
                                            int value)
        Unsafe version of protectedSubmit.