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.NativeResource
Structure specifying conditional rendering begin info.Description
If the 32-bit value at
offset
inbuffer
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 bits.offset
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
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.buffer
– a buffer containing the predicate for conditional rendering.offset
– the byte offset intobuffer
where the predicate is located.flags
– a bitmask ofVkConditionalRenderingFlagsEXT
specifying the behavior of conditional rendering.
Layout
struct VkConditionalRenderingBeginInfoEXT { VkStructureType sType; void const * pNext; VkBuffer buffer; VkDeviceSize offset; VkConditionalRenderingFlagsEXT flags; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkConditionalRenderingBeginInfoEXT.Buffer
An array ofVkConditionalRenderingBeginInfoEXT
structs.
-
Constructor Summary
Constructors Constructor Description VkConditionalRenderingBeginInfoEXT(java.nio.ByteBuffer container)
Creates aVkConditionalRenderingBeginInfoEXT
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description long
buffer()
Returns the value of thebuffer
field.VkConditionalRenderingBeginInfoEXT
buffer(long value)
Sets the specified value to thebuffer
field.static VkConditionalRenderingBeginInfoEXT
calloc()
Returns a newVkConditionalRenderingBeginInfoEXT
instance allocated withmemCalloc
.static VkConditionalRenderingBeginInfoEXT.Buffer
calloc(int capacity)
Returns a newVkConditionalRenderingBeginInfoEXT.Buffer
instance allocated withmemCalloc
.static VkConditionalRenderingBeginInfoEXT
callocStack()
Returns a newVkConditionalRenderingBeginInfoEXT
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkConditionalRenderingBeginInfoEXT.Buffer
callocStack(int capacity)
Returns a newVkConditionalRenderingBeginInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkConditionalRenderingBeginInfoEXT.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkConditionalRenderingBeginInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkConditionalRenderingBeginInfoEXT
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkConditionalRenderingBeginInfoEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkConditionalRenderingBeginInfoEXT
create()
Returns a newVkConditionalRenderingBeginInfoEXT
instance allocated withBufferUtils
.static VkConditionalRenderingBeginInfoEXT.Buffer
create(int capacity)
Returns a newVkConditionalRenderingBeginInfoEXT.Buffer
instance allocated withBufferUtils
.static VkConditionalRenderingBeginInfoEXT
create(long address)
Returns a newVkConditionalRenderingBeginInfoEXT
instance for the specified memory address.static VkConditionalRenderingBeginInfoEXT.Buffer
create(long address, int capacity)
Create aVkConditionalRenderingBeginInfoEXT.Buffer
instance at the specified memory.static VkConditionalRenderingBeginInfoEXT
createSafe(long address)
static VkConditionalRenderingBeginInfoEXT.Buffer
createSafe(long address, int capacity)
int
flags()
Returns the value of theflags
field.VkConditionalRenderingBeginInfoEXT
flags(int value)
Sets the specified value to theflags
field.static VkConditionalRenderingBeginInfoEXT
malloc()
Returns a newVkConditionalRenderingBeginInfoEXT
instance allocated withmemAlloc
.static VkConditionalRenderingBeginInfoEXT.Buffer
malloc(int capacity)
Returns a newVkConditionalRenderingBeginInfoEXT.Buffer
instance allocated withmemAlloc
.static VkConditionalRenderingBeginInfoEXT
mallocStack()
Returns a newVkConditionalRenderingBeginInfoEXT
instance allocated on the thread-localMemoryStack
.static VkConditionalRenderingBeginInfoEXT.Buffer
mallocStack(int capacity)
Returns a newVkConditionalRenderingBeginInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
.static VkConditionalRenderingBeginInfoEXT.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkConditionalRenderingBeginInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
.static VkConditionalRenderingBeginInfoEXT
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkConditionalRenderingBeginInfoEXT
instance allocated on the specifiedMemoryStack
.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()
Returns the value of theoffset
field.VkConditionalRenderingBeginInfoEXT
offset(long value)
Sets the specified value to theoffset
field.long
pNext()
Returns the value of thepNext
field.VkConditionalRenderingBeginInfoEXT
pNext(long value)
Sets the specified value to thepNext
field.VkConditionalRenderingBeginInfoEXT
set(int sType, long pNext, long buffer, long offset, int flags)
Initializes this struct with the specified values.VkConditionalRenderingBeginInfoEXT
set(VkConditionalRenderingBeginInfoEXT src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkConditionalRenderingBeginInfoEXT
sType(int value)
Sets the specified value to thesType
field.
-
-
-
Constructor Detail
-
VkConditionalRenderingBeginInfoEXT
public VkConditionalRenderingBeginInfoEXT(java.nio.ByteBuffer container)
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 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.
-
buffer
public long buffer()
Returns the value of thebuffer
field.
-
offset
public long offset()
Returns the value of theoffset
field.
-
flags
public int flags()
Returns the value of theflags
field.
-
sType
public VkConditionalRenderingBeginInfoEXT sType(int value)
Sets the specified value 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 newVkConditionalRenderingBeginInfoEXT
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkConditionalRenderingBeginInfoEXT calloc()
Returns a newVkConditionalRenderingBeginInfoEXT
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkConditionalRenderingBeginInfoEXT create()
Returns a newVkConditionalRenderingBeginInfoEXT
instance allocated withBufferUtils
.
-
create
public static VkConditionalRenderingBeginInfoEXT create(long address)
Returns a newVkConditionalRenderingBeginInfoEXT
instance for the specified memory address.
-
createSafe
@Nullable public static VkConditionalRenderingBeginInfoEXT createSafe(long address)
-
malloc
public static VkConditionalRenderingBeginInfoEXT.Buffer malloc(int capacity)
Returns a newVkConditionalRenderingBeginInfoEXT.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkConditionalRenderingBeginInfoEXT.Buffer calloc(int capacity)
Returns a newVkConditionalRenderingBeginInfoEXT.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkConditionalRenderingBeginInfoEXT.Buffer create(int capacity)
Returns a newVkConditionalRenderingBeginInfoEXT.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkConditionalRenderingBeginInfoEXT.Buffer create(long address, int capacity)
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
public static VkConditionalRenderingBeginInfoEXT mallocStack()
Returns a newVkConditionalRenderingBeginInfoEXT
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkConditionalRenderingBeginInfoEXT callocStack()
Returns a newVkConditionalRenderingBeginInfoEXT
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkConditionalRenderingBeginInfoEXT mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkConditionalRenderingBeginInfoEXT
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkConditionalRenderingBeginInfoEXT callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkConditionalRenderingBeginInfoEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkConditionalRenderingBeginInfoEXT.Buffer mallocStack(int capacity)
Returns a newVkConditionalRenderingBeginInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkConditionalRenderingBeginInfoEXT.Buffer callocStack(int capacity)
Returns a newVkConditionalRenderingBeginInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkConditionalRenderingBeginInfoEXT.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkConditionalRenderingBeginInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkConditionalRenderingBeginInfoEXT.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkConditionalRenderingBeginInfoEXT.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()
.
-
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
.
-
-