Package org.lwjgl.vulkan
Class VkProtectedSubmitInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.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 beTRUE
. - If
protectedSubmit
isTRUE
, then each element of thepCommandBuffers
array must be a protected command buffer. - If
protectedSubmit
isFALSE
, then each element of thepCommandBuffers
array must be an unprotected command buffer. - If the
VkSubmitInfo
::pNext
chain does not include aVkProtectedSubmitInfo
structure, then each element of the command buffer of thepCommandBuffers
array must be an unprotected command buffer.
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_PROTECTED_SUBMIT_INFO
Member documentation
protectedSubmit
– specifies whether the batch is protected. IfprotectedSubmit
isTRUE
, the batch is protected. IfprotectedSubmit
isFALSE
, the batch is unprotected. If theVkSubmitInfo
::pNext
chain does not contain this structure, the batch is unprotected.
Layout
struct VkProtectedSubmitInfo { VkStructureType sType; void const * pNext; VkBool32 protectedSubmit; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkProtectedSubmitInfo.Buffer
An array ofVkProtectedSubmitInfo
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
PNEXT
PROTECTEDSUBMITThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STYPE
The struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkProtectedSubmitInfo(java.nio.ByteBuffer container)
Creates aVkProtectedSubmitInfo
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkProtectedSubmitInfo
calloc()
Returns a newVkProtectedSubmitInfo
instance allocated withmemCalloc
.static VkProtectedSubmitInfo.Buffer
calloc(int capacity)
Returns a newVkProtectedSubmitInfo.Buffer
instance allocated withmemCalloc
.static VkProtectedSubmitInfo
callocStack()
Returns a newVkProtectedSubmitInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkProtectedSubmitInfo.Buffer
callocStack(int capacity)
Returns a newVkProtectedSubmitInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkProtectedSubmitInfo.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkProtectedSubmitInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkProtectedSubmitInfo
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkProtectedSubmitInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkProtectedSubmitInfo
create()
Returns a newVkProtectedSubmitInfo
instance allocated withBufferUtils
.static VkProtectedSubmitInfo.Buffer
create(int capacity)
Returns a newVkProtectedSubmitInfo.Buffer
instance allocated withBufferUtils
.static VkProtectedSubmitInfo
create(long address)
Returns a newVkProtectedSubmitInfo
instance for the specified memory address.static VkProtectedSubmitInfo.Buffer
create(long address, int capacity)
Create aVkProtectedSubmitInfo.Buffer
instance at the specified memory.static VkProtectedSubmitInfo
createSafe(long address)
static VkProtectedSubmitInfo.Buffer
createSafe(long address, int capacity)
static VkProtectedSubmitInfo
malloc()
Returns a newVkProtectedSubmitInfo
instance allocated withmemAlloc
.static VkProtectedSubmitInfo.Buffer
malloc(int capacity)
Returns a newVkProtectedSubmitInfo.Buffer
instance allocated withmemAlloc
.static VkProtectedSubmitInfo
mallocStack()
Returns a newVkProtectedSubmitInfo
instance allocated on the thread-localMemoryStack
.static VkProtectedSubmitInfo.Buffer
mallocStack(int capacity)
Returns a newVkProtectedSubmitInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkProtectedSubmitInfo.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkProtectedSubmitInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkProtectedSubmitInfo
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkProtectedSubmitInfo
instance allocated on the specifiedMemoryStack
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static int
nprotectedSubmit(long struct)
Unsafe version ofprotectedSubmit()
.static void
nprotectedSubmit(long struct, int value)
Unsafe version ofprotectedSubmit
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.long
pNext()
Returns the value of thepNext
field.VkProtectedSubmitInfo
pNext(long value)
Sets the specified value to thepNext
field.boolean
protectedSubmit()
Returns the value of theprotectedSubmit
field.VkProtectedSubmitInfo
protectedSubmit(boolean value)
Sets the specified value to theprotectedSubmit
field.VkProtectedSubmitInfo
set(int sType, long pNext, boolean protectedSubmit)
Initializes this struct with the specified values.VkProtectedSubmitInfo
set(VkProtectedSubmitInfo src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkProtectedSubmitInfo
sType(int value)
Sets the specified value to thesType
field.
-
-
-
Constructor Detail
-
VkProtectedSubmitInfo
public VkProtectedSubmitInfo(java.nio.ByteBuffer container)
Creates aVkProtectedSubmitInfo
instance at the current position of the specifiedByteBuffer
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 classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
protectedSubmit
public boolean protectedSubmit()
Returns the value of theprotectedSubmit
field.
-
sType
public VkProtectedSubmitInfo sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkProtectedSubmitInfo pNext(long value)
Sets the specified value to thepNext
field.
-
protectedSubmit
public VkProtectedSubmitInfo protectedSubmit(boolean value)
Sets the specified value to theprotectedSubmit
field.
-
set
public VkProtectedSubmitInfo set(int sType, long pNext, boolean protectedSubmit)
Initializes this struct with the specified values.
-
set
public VkProtectedSubmitInfo set(VkProtectedSubmitInfo src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkProtectedSubmitInfo malloc()
Returns a newVkProtectedSubmitInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkProtectedSubmitInfo calloc()
Returns a newVkProtectedSubmitInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkProtectedSubmitInfo create()
Returns a newVkProtectedSubmitInfo
instance allocated withBufferUtils
.
-
create
public static VkProtectedSubmitInfo create(long address)
Returns a newVkProtectedSubmitInfo
instance for the specified memory address.
-
createSafe
@Nullable public static VkProtectedSubmitInfo createSafe(long address)
-
malloc
public static VkProtectedSubmitInfo.Buffer malloc(int capacity)
Returns a newVkProtectedSubmitInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkProtectedSubmitInfo.Buffer calloc(int capacity)
Returns a newVkProtectedSubmitInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkProtectedSubmitInfo.Buffer create(int capacity)
Returns a newVkProtectedSubmitInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkProtectedSubmitInfo.Buffer create(long address, int capacity)
Create aVkProtectedSubmitInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkProtectedSubmitInfo.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkProtectedSubmitInfo mallocStack()
Returns a newVkProtectedSubmitInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkProtectedSubmitInfo callocStack()
Returns a newVkProtectedSubmitInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkProtectedSubmitInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkProtectedSubmitInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkProtectedSubmitInfo callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkProtectedSubmitInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkProtectedSubmitInfo.Buffer mallocStack(int capacity)
Returns a newVkProtectedSubmitInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkProtectedSubmitInfo.Buffer callocStack(int capacity)
Returns a newVkProtectedSubmitInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkProtectedSubmitInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkProtectedSubmitInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkProtectedSubmitInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkProtectedSubmitInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType()
.
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext()
.
-
nprotectedSubmit
public static int nprotectedSubmit(long struct)
Unsafe version ofprotectedSubmit()
.
-
nsType
public static void nsType(long struct, int value)
Unsafe version ofsType
.
-
npNext
public static void npNext(long struct, long value)
Unsafe version ofpNext
.
-
nprotectedSubmit
public static void nprotectedSubmit(long struct, int value)
Unsafe version ofprotectedSubmit
.
-
-