Package org.lwjgl.vulkan
Class VkConditionalRenderingBeginInfoEXT
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkConditionalRenderingBeginInfoEXT
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkConditionalRenderingBeginInfoEXT extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying conditional rendering begin information.Description
If the 32-bit value at
offsetinbuffermemory 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
CmdBeginConditionalRenderingEXTLayout
struct VkConditionalRenderingBeginInfoEXT { VkStructureTypesType(); void const *pNext(); VkBufferbuffer(); VkDeviceSizeoffset(); VkConditionalRenderingFlagsEXTflags(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkConditionalRenderingBeginInfoEXT.BufferAn array ofVkConditionalRenderingBeginInfoEXTstructs.
-
Constructor Summary
Constructors Constructor Description VkConditionalRenderingBeginInfoEXT(java.nio.ByteBuffer container)Creates aVkConditionalRenderingBeginInfoEXTinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description longbuffer()a buffer containing the predicate for conditional rendering.VkConditionalRenderingBeginInfoEXTbuffer(long value)Sets the specified value to thebuffer()field.static VkConditionalRenderingBeginInfoEXTcalloc()Returns a newVkConditionalRenderingBeginInfoEXTinstance allocated withmemCalloc.static VkConditionalRenderingBeginInfoEXT.Buffercalloc(int capacity)Returns a newVkConditionalRenderingBeginInfoEXT.Bufferinstance allocated withmemCalloc.static VkConditionalRenderingBeginInfoEXT.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkConditionalRenderingBeginInfoEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkConditionalRenderingBeginInfoEXTcalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkConditionalRenderingBeginInfoEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkConditionalRenderingBeginInfoEXTcallocStack()Deprecated.static VkConditionalRenderingBeginInfoEXT.BuffercallocStack(int capacity)Deprecated.static VkConditionalRenderingBeginInfoEXT.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkConditionalRenderingBeginInfoEXTcallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static VkConditionalRenderingBeginInfoEXTcreate()Returns a newVkConditionalRenderingBeginInfoEXTinstance allocated withBufferUtils.static VkConditionalRenderingBeginInfoEXT.Buffercreate(int capacity)Returns a newVkConditionalRenderingBeginInfoEXT.Bufferinstance allocated withBufferUtils.static VkConditionalRenderingBeginInfoEXTcreate(long address)Returns a newVkConditionalRenderingBeginInfoEXTinstance for the specified memory address.static VkConditionalRenderingBeginInfoEXT.Buffercreate(long address, int capacity)Create aVkConditionalRenderingBeginInfoEXT.Bufferinstance at the specified memory.static VkConditionalRenderingBeginInfoEXTcreateSafe(long address)static VkConditionalRenderingBeginInfoEXT.BuffercreateSafe(long address, int capacity)intflags()a bitmask ofVkConditionalRenderingFlagsEXTspecifying the behavior of conditional rendering.VkConditionalRenderingBeginInfoEXTflags(int value)Sets the specified value to theflags()field.static VkConditionalRenderingBeginInfoEXTmalloc()Returns a newVkConditionalRenderingBeginInfoEXTinstance allocated withmemAlloc.static VkConditionalRenderingBeginInfoEXT.Buffermalloc(int capacity)Returns a newVkConditionalRenderingBeginInfoEXT.Bufferinstance allocated withmemAlloc.static VkConditionalRenderingBeginInfoEXT.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkConditionalRenderingBeginInfoEXT.Bufferinstance allocated on the specifiedMemoryStack.static VkConditionalRenderingBeginInfoEXTmalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkConditionalRenderingBeginInfoEXTinstance allocated on the specifiedMemoryStack.static VkConditionalRenderingBeginInfoEXTmallocStack()Deprecated.static VkConditionalRenderingBeginInfoEXT.BuffermallocStack(int capacity)Deprecated.static VkConditionalRenderingBeginInfoEXT.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkConditionalRenderingBeginInfoEXTmallocStack(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.VkConditionalRenderingBeginInfoEXToffset(long value)Sets the specified value to theoffset()field.longpNext()NULLor a pointer to a structure extending this structure.VkConditionalRenderingBeginInfoEXTpNext(long value)Sets the specified value to thepNext()field.VkConditionalRenderingBeginInfoEXTset(int sType, long pNext, long buffer, long offset, int flags)Initializes this struct with the specified values.VkConditionalRenderingBeginInfoEXTset(VkConditionalRenderingBeginInfoEXT src)Copies the specified struct data to this struct.intsizeof()intsType()the type of this structure.VkConditionalRenderingBeginInfoEXTsType(int value)Sets the specified value to thesType()field.VkConditionalRenderingBeginInfoEXTsType$Default()Sets theSTRUCTURE_TYPE_CONDITIONAL_RENDERING_BEGIN_INFO_EXTvalue to thesType()field.
-
-
-
Constructor Detail
-
VkConditionalRenderingBeginInfoEXT
public VkConditionalRenderingBeginInfoEXT(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
the type of 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
public VkConditionalRenderingBeginInfoEXT sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkConditionalRenderingBeginInfoEXT sType$Default()
Sets theSTRUCTURE_TYPE_CONDITIONAL_RENDERING_BEGIN_INFO_EXTvalue to thesType()field.
-
pNext
public VkConditionalRenderingBeginInfoEXT pNext(long value)
Sets the specified value to thepNext()field.
-
buffer
public VkConditionalRenderingBeginInfoEXT buffer(long value)
Sets the specified value to thebuffer()field.
-
offset
public VkConditionalRenderingBeginInfoEXT offset(long value)
Sets the specified value to theoffset()field.
-
flags
public VkConditionalRenderingBeginInfoEXT flags(int value)
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
public VkConditionalRenderingBeginInfoEXT set(VkConditionalRenderingBeginInfoEXT src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkConditionalRenderingBeginInfoEXT malloc()
Returns a newVkConditionalRenderingBeginInfoEXTinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkConditionalRenderingBeginInfoEXT calloc()
Returns a newVkConditionalRenderingBeginInfoEXTinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkConditionalRenderingBeginInfoEXT create()
Returns a newVkConditionalRenderingBeginInfoEXTinstance allocated withBufferUtils.
-
create
public static VkConditionalRenderingBeginInfoEXT create(long address)
Returns a newVkConditionalRenderingBeginInfoEXTinstance for the specified memory address.
-
createSafe
@Nullable public static VkConditionalRenderingBeginInfoEXT createSafe(long address)
-
malloc
public static VkConditionalRenderingBeginInfoEXT.Buffer malloc(int capacity)
Returns a newVkConditionalRenderingBeginInfoEXT.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkConditionalRenderingBeginInfoEXT.Buffer calloc(int capacity)
Returns a newVkConditionalRenderingBeginInfoEXT.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkConditionalRenderingBeginInfoEXT.Buffer create(int capacity)
Returns a newVkConditionalRenderingBeginInfoEXT.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkConditionalRenderingBeginInfoEXT.Buffer create(long address, int capacity)
Create aVkConditionalRenderingBeginInfoEXT.Bufferinstance 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 public static VkConditionalRenderingBeginInfoEXT mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkConditionalRenderingBeginInfoEXT 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 public static VkConditionalRenderingBeginInfoEXT.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkConditionalRenderingBeginInfoEXT.Buffer callocStack(int capacity)
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
public static VkConditionalRenderingBeginInfoEXT malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkConditionalRenderingBeginInfoEXTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkConditionalRenderingBeginInfoEXT calloc(org.lwjgl.system.MemoryStack stack)
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:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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:
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().
-
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.
-
-