Package org.lwjgl.vulkan
Class VkConditionalRenderingBeginInfoEXT
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkConditionalRenderingBeginInfoEXT>
org.lwjgl.vulkan.VkConditionalRenderingBeginInfoEXT
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
public class VkConditionalRenderingBeginInfoEXT
extends Struct<VkConditionalRenderingBeginInfoEXT>
implements NativeResource
Structure specifying conditional rendering begin information.
Description
If the 32-bit value at offset
in buffer
memory is zero, then the rendering commands are discarded, otherwise they are executed as normal. If the value of the predicate in buffer memory changes while conditional rendering is active, the rendering commands may be discarded in an implementation-dependent way. Some implementations may latch the value of the predicate upon beginning conditional rendering while others may read it before every rendering command.
Valid Usage
- If
buffer
is non-sparse then it must be bound completely and contiguously to a singleVkDeviceMemory
object buffer
must have been created with theBUFFER_USAGE_CONDITIONAL_RENDERING_BIT_EXT
bit setoffset
must be less than the size ofbuffer
by at least 32 bitsoffset
must be a multiple of 4
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_CONDITIONAL_RENDERING_BEGIN_INFO_EXT
pNext
must beNULL
buffer
must be a validVkBuffer
handleflags
must be a valid combination ofVkConditionalRenderingFlagBitsEXT
values
See Also
CmdBeginConditionalRenderingEXT
Layout
struct VkConditionalRenderingBeginInfoEXT {
VkStructureType sType()
;
void const * pNext()
;
VkBuffer buffer()
;
VkDeviceSize offset()
;
VkConditionalRenderingFlagsEXT flags()
;
}
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
An array ofVkConditionalRenderingBeginInfoEXT
structs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionVkConditionalRenderingBeginInfoEXT
(ByteBuffer container) Creates aVkConditionalRenderingBeginInfoEXT
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionlong
buffer()
a buffer containing the predicate for conditional rendering.buffer
(long value) Sets the specified value to thebuffer()
field.calloc()
Returns a newVkConditionalRenderingBeginInfoEXT
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkConditionalRenderingBeginInfoEXT.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkConditionalRenderingBeginInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.calloc
(MemoryStack stack) Returns a newVkConditionalRenderingBeginInfoEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.Deprecated.callocStack
(int capacity) Deprecated.callocStack
(int capacity, MemoryStack stack) Deprecated.callocStack
(MemoryStack stack) Deprecated.create()
Returns a newVkConditionalRenderingBeginInfoEXT
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkConditionalRenderingBeginInfoEXT.Buffer
instance allocated withBufferUtils
.create
(long address) Returns a newVkConditionalRenderingBeginInfoEXT
instance for the specified memory address.create
(long address, int capacity) Create aVkConditionalRenderingBeginInfoEXT.Buffer
instance at the specified memory.createSafe
(long address) createSafe
(long address, int capacity) int
flags()
a bitmask ofVkConditionalRenderingFlagsEXT
specifying the behavior of conditional rendering.flags
(int value) Sets the specified value to theflags()
field.malloc()
Returns a newVkConditionalRenderingBeginInfoEXT
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkConditionalRenderingBeginInfoEXT.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkConditionalRenderingBeginInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
.malloc
(MemoryStack stack) Returns a newVkConditionalRenderingBeginInfoEXT
instance allocated on the specifiedMemoryStack
.Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.mallocStack
(MemoryStack stack) Deprecated.static long
nbuffer
(long struct) Unsafe version ofbuffer()
.static void
nbuffer
(long struct, long value) Unsafe version ofbuffer
.static int
nflags
(long struct) Unsafe version offlags()
.static void
nflags
(long struct, int value) Unsafe version offlags
.static long
noffset
(long struct) Unsafe version ofoffset()
.static void
noffset
(long struct, long value) Unsafe version ofoffset
.static long
npNext
(long struct) Unsafe version ofpNext()
.static void
npNext
(long struct, long value) Unsafe version ofpNext
.static int
nsType
(long struct) Unsafe version ofsType()
.static void
nsType
(long struct, int value) Unsafe version ofsType
.long
offset()
the byte offset intobuffer
where the predicate is located.offset
(long value) Sets the specified value to theoffset()
field.long
pNext()
NULL
or a pointer to a structure extending this structure.pNext
(long value) Sets the specified value to thepNext()
field.set
(int sType, long pNext, long buffer, long offset, int flags) Initializes this struct with the specified values.Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.int
sType()
aVkStructureType
value identifying this structure.sType
(int value) Sets the specified value to thesType()
field.Sets theSTRUCTURE_TYPE_CONDITIONAL_RENDERING_BEGIN_INFO_EXT
value to thesType()
field.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
BUFFER
public static final int BUFFERThe struct member offsets. -
OFFSET
public static final int OFFSETThe struct member offsets. -
FLAGS
public static final int FLAGSThe struct member offsets.
-
-
Constructor Details
-
VkConditionalRenderingBeginInfoEXT
Creates aVkConditionalRenderingBeginInfoEXT
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 Details
-
sizeof
public int sizeof()Description copied from class:Struct
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkConditionalRenderingBeginInfoEXT>
-
sType
public int sType()aVkStructureType
value identifying this structure. -
pNext
public long pNext()NULL
or a pointer to a structure extending this structure. -
buffer
public long buffer()a buffer containing the predicate for conditional rendering. -
offset
public long offset()the byte offset intobuffer
where the predicate is located. -
flags
public int flags()a bitmask ofVkConditionalRenderingFlagsEXT
specifying the behavior of conditional rendering. -
sType
Sets the specified value to thesType()
field. -
sType$Default
Sets theSTRUCTURE_TYPE_CONDITIONAL_RENDERING_BEGIN_INFO_EXT
value to thesType()
field. -
pNext
Sets the specified value to thepNext()
field. -
buffer
Sets the specified value to thebuffer()
field. -
offset
Sets the specified value to theoffset()
field. -
flags
Sets the specified value to theflags()
field. -
set
public VkConditionalRenderingBeginInfoEXT set(int sType, long pNext, long buffer, long offset, int flags) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
Returns a newVkConditionalRenderingBeginInfoEXT
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkConditionalRenderingBeginInfoEXT
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkConditionalRenderingBeginInfoEXT
instance allocated withBufferUtils
. -
create
Returns a newVkConditionalRenderingBeginInfoEXT
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkConditionalRenderingBeginInfoEXT.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkConditionalRenderingBeginInfoEXT.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkConditionalRenderingBeginInfoEXT.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkConditionalRenderingBeginInfoEXT.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkConditionalRenderingBeginInfoEXT.Buffer createSafe(long address, int capacity) -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
@Deprecated public static VkConditionalRenderingBeginInfoEXT.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkConditionalRenderingBeginInfoEXT.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkConditionalRenderingBeginInfoEXT
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkConditionalRenderingBeginInfoEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkConditionalRenderingBeginInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkConditionalRenderingBeginInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType()
. -
npNext
public static long npNext(long struct) Unsafe version ofpNext()
. -
nbuffer
public static long nbuffer(long struct) Unsafe version ofbuffer()
. -
noffset
public static long noffset(long struct) Unsafe version ofoffset()
. -
nflags
public static int nflags(long struct) Unsafe version offlags()
. -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType
. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext
. -
nbuffer
public static void nbuffer(long struct, long value) Unsafe version ofbuffer
. -
noffset
public static void noffset(long struct, long value) Unsafe version ofoffset
. -
nflags
public static void nflags(long struct, int value) Unsafe version offlags
.
-