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,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkConditionalRenderingBeginInfoEXT
extends org.lwjgl.system.Struct<VkConditionalRenderingBeginInfoEXT>
implements org.lwjgl.system.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
bufferis non-sparse then it must be bound completely and contiguously to a singleVkDeviceMemoryobject buffermust have been created with theBUFFER_USAGE_CONDITIONAL_RENDERING_BIT_EXTbit setoffsetmust be less than the size ofbufferby at least 32 bitsoffsetmust be a multiple of 4
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_CONDITIONAL_RENDERING_BEGIN_INFO_EXTpNextmust beNULLbuffermust be a validVkBufferhandleflagsmust be a valid combination ofVkConditionalRenderingFlagBitsEXTvalues
See Also
CmdBeginConditionalRenderingEXT
Layout
struct VkConditionalRenderingBeginInfoEXT {
VkStructureType sType();
void const * pNext();
VkBuffer buffer();
VkDeviceSize offset();
VkConditionalRenderingFlagsEXT flags();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkConditionalRenderingBeginInfoEXTstructs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkConditionalRenderingBeginInfoEXT(ByteBuffer container) Creates aVkConditionalRenderingBeginInfoEXTinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionlongbuffer()a buffer containing the predicate for conditional rendering.buffer(long value) Sets the specified value to thebuffer()field.calloc()Returns a newVkConditionalRenderingBeginInfoEXTinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkConditionalRenderingBeginInfoEXT.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkConditionalRenderingBeginInfoEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkConditionalRenderingBeginInfoEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.Deprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.create()Returns a newVkConditionalRenderingBeginInfoEXTinstance allocated withBufferUtils.create(int capacity) Returns a newVkConditionalRenderingBeginInfoEXT.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkConditionalRenderingBeginInfoEXTinstance for the specified memory address.create(long address, int capacity) Create aVkConditionalRenderingBeginInfoEXT.Bufferinstance at the specified memory.static @Nullable VkConditionalRenderingBeginInfoEXTcreateSafe(long address) static @Nullable VkConditionalRenderingBeginInfoEXT.BuffercreateSafe(long address, int capacity) intflags()a bitmask ofVkConditionalRenderingFlagsEXTspecifying the behavior of conditional rendering.flags(int value) Sets the specified value to theflags()field.malloc()Returns a newVkConditionalRenderingBeginInfoEXTinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkConditionalRenderingBeginInfoEXT.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkConditionalRenderingBeginInfoEXT.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkConditionalRenderingBeginInfoEXTinstance allocated on the specifiedMemoryStack.Deprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static longnbuffer(long struct) Unsafe version ofbuffer().static voidnbuffer(long struct, long value) Unsafe version ofbuffer.static intnflags(long struct) Unsafe version offlags().static voidnflags(long struct, int value) Unsafe version offlags.static longnoffset(long struct) Unsafe version ofoffset().static voidnoffset(long struct, long value) Unsafe version ofoffset.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.longoffset()the byte offset intobufferwhere the predicate is located.offset(long value) Sets the specified value to theoffset()field.longpNext()NULLor 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.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_CONDITIONAL_RENDERING_BEGIN_INFO_EXTvalue to thesType()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods 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 aVkConditionalRenderingBeginInfoEXTinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct<VkConditionalRenderingBeginInfoEXT>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor 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 intobufferwhere the predicate is located. -
flags
public int flags()a bitmask ofVkConditionalRenderingFlagsEXTspecifying the behavior of conditional rendering. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_CONDITIONAL_RENDERING_BEGIN_INFO_EXTvalue 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 newVkConditionalRenderingBeginInfoEXTinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkConditionalRenderingBeginInfoEXTinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkConditionalRenderingBeginInfoEXTinstance allocated withBufferUtils. -
create
Returns a newVkConditionalRenderingBeginInfoEXTinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkConditionalRenderingBeginInfoEXT.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkConditionalRenderingBeginInfoEXT.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkConditionalRenderingBeginInfoEXT.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkConditionalRenderingBeginInfoEXT.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable 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 public static VkConditionalRenderingBeginInfoEXT mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
@Deprecated public static VkConditionalRenderingBeginInfoEXT callocStack(org.lwjgl.system.MemoryStack stack) 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, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkConditionalRenderingBeginInfoEXT.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkConditionalRenderingBeginInfoEXTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkConditionalRenderingBeginInfoEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkConditionalRenderingBeginInfoEXT.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkConditionalRenderingBeginInfoEXT.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkConditionalRenderingBeginInfoEXT.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkConditionalRenderingBeginInfoEXT.Bufferinstance allocated on the specifiedMemoryStackand 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.
-