Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkConditionalRenderingBeginInfoEXT

extends Struct<VkConditionalRenderingBeginInfoEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

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
Valid Usage (Implicit)
See Also

CmdBeginConditionalRenderingEXT

Layout


struct VkConditionalRenderingBeginInfoEXT {
    VkStructureType sType;
    void const * pNext;
    VkBuffer buffer;
    VkDeviceSize offset;
    VkConditionalRenderingFlagsEXT flags;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
BUFFER

The struct member offsets.

public static final int
FLAGS

The struct member offsets.

public static final int
OFFSET

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkConditionalRenderingBeginInfoEXT(ByteBuffer container)

Creates a VkConditionalRenderingBeginInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public long
buffer()

a buffer containing the predicate for conditional rendering.

public VkConditionalRenderingBeginInfoEXT
buffer(long value)

Sets the specified value to the buffer field.

public static VkConditionalRenderingBeginInfoEXT
calloc()

Returns a new VkConditionalRenderingBeginInfoEXT instance allocated with memCalloc.

public static VkConditionalRenderingBeginInfoEXT.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkConditionalRenderingBeginInfoEXT.Buffer instance allocated with memCalloc.

public static VkConditionalRenderingBeginInfoEXT
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkConditionalRenderingBeginInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkConditionalRenderingBeginInfoEXT.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkConditionalRenderingBeginInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkConditionalRenderingBeginInfoEXT
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkConditionalRenderingBeginInfoEXT
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkConditionalRenderingBeginInfoEXT.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkConditionalRenderingBeginInfoEXT.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkConditionalRenderingBeginInfoEXT
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkConditionalRenderingBeginInfoEXT
create()

Returns a new VkConditionalRenderingBeginInfoEXT instance allocated with BufferUtils.

public static VkConditionalRenderingBeginInfoEXT
create(long address)

Returns a new VkConditionalRenderingBeginInfoEXT instance for the specified memory address.

public static VkConditionalRenderingBeginInfoEXT.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkConditionalRenderingBeginInfoEXT.Buffer instance allocated with BufferUtils.

public static VkConditionalRenderingBeginInfoEXT.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkConditionalRenderingBeginInfoEXT.Buffer instance at the specified memory.

public static VkConditionalRenderingBeginInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkConditionalRenderingBeginInfoEXT.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public int
flags()

a bitmask of VkConditionalRenderingFlagsEXT specifying the behavior of conditional rendering.

public VkConditionalRenderingBeginInfoEXT
flags(int value)

Sets the specified value to the flags field.

public static VkConditionalRenderingBeginInfoEXT
malloc()

Returns a new VkConditionalRenderingBeginInfoEXT instance allocated with memAlloc.

public static VkConditionalRenderingBeginInfoEXT.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkConditionalRenderingBeginInfoEXT.Buffer instance allocated with memAlloc.

public static VkConditionalRenderingBeginInfoEXT
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkConditionalRenderingBeginInfoEXT instance allocated on the specified MemoryStack.

public static VkConditionalRenderingBeginInfoEXT.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkConditionalRenderingBeginInfoEXT.Buffer instance allocated on the specified MemoryStack.

public static VkConditionalRenderingBeginInfoEXT
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkConditionalRenderingBeginInfoEXT
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkConditionalRenderingBeginInfoEXT.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkConditionalRenderingBeginInfoEXT.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static long
nbuffer(long struct)

Unsafe version of buffer.

public static void
nbuffer(long struct, long value)

Unsafe version of buffer.

public static int
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

public static long
noffset(long struct)

Unsafe version of offset.

public static void
noffset(long struct, long value)

Unsafe version of offset.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
offset()

the byte offset into buffer where the predicate is located.

public VkConditionalRenderingBeginInfoEXT
offset(long value)

Sets the specified value to the offset field.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkConditionalRenderingBeginInfoEXT
pNext(long value)

Sets the specified value to the pNext field.

public VkConditionalRenderingBeginInfoEXT
set(int sType, long pNext, long buffer, long offset, int flags)

Initializes this struct with the specified values.

public VkConditionalRenderingBeginInfoEXT

Returns:

this struct
set
(VkConditionalRenderingBeginInfoEXT
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkConditionalRenderingBeginInfoEXT
sType(int value)

Sets the specified value to the sType field.

public VkConditionalRenderingBeginInfoEXT
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

BUFFERback to summary
public static final int BUFFER

The struct member offsets.

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

OFFSETback to summary
public static final int OFFSET

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkConditionalRenderingBeginInfoEXTback to summary
protected VkConditionalRenderingBeginInfoEXT(long address, ByteBuffer container)
VkConditionalRenderingBeginInfoEXTback to summary
public VkConditionalRenderingBeginInfoEXT(ByteBuffer container)

Creates a VkConditionalRenderingBeginInfoEXT instance at the current position of the specified ByteBuffer 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

bufferback to summary
public long buffer()

a buffer containing the predicate for conditional rendering.

Annotations
@NativeType:VkBuffer
bufferback to summary
public VkConditionalRenderingBeginInfoEXT buffer(long value)

Sets the specified value to the buffer field.

callocback to summary
public static VkConditionalRenderingBeginInfoEXT calloc()

Returns a new VkConditionalRenderingBeginInfoEXT instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VkConditionalRenderingBeginInfoEXT.Buffer calloc(int capacity)

Returns a new VkConditionalRenderingBeginInfoEXT.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkConditionalRenderingBeginInfoEXT calloc(MemoryStack stack)

Returns a new VkConditionalRenderingBeginInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkConditionalRenderingBeginInfoEXT.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkConditionalRenderingBeginInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkConditionalRenderingBeginInfoEXT callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkConditionalRenderingBeginInfoEXT callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkConditionalRenderingBeginInfoEXT.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkConditionalRenderingBeginInfoEXT.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected VkConditionalRenderingBeginInfoEXT create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkConditionalRenderingBeginInfoEXT create()

Returns a new VkConditionalRenderingBeginInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkConditionalRenderingBeginInfoEXT create(long address)

Returns a new VkConditionalRenderingBeginInfoEXT instance for the specified memory address.

createback to summary
public static VkConditionalRenderingBeginInfoEXT.Buffer create(int capacity)

Returns a new VkConditionalRenderingBeginInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkConditionalRenderingBeginInfoEXT.Buffer create(long address, int capacity)

Create a VkConditionalRenderingBeginInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkConditionalRenderingBeginInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkConditionalRenderingBeginInfoEXT.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public int flags()

a bitmask of VkConditionalRenderingFlagsEXT specifying the behavior of conditional rendering.

Annotations
@NativeType:VkConditionalRenderingFlagsEXT
flagsback to summary
public VkConditionalRenderingBeginInfoEXT flags(int value)

Sets the specified value to the flags field.

mallocback to summary
public static VkConditionalRenderingBeginInfoEXT malloc()

Returns a new VkConditionalRenderingBeginInfoEXT instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VkConditionalRenderingBeginInfoEXT.Buffer malloc(int capacity)

Returns a new VkConditionalRenderingBeginInfoEXT.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkConditionalRenderingBeginInfoEXT malloc(MemoryStack stack)

Returns a new VkConditionalRenderingBeginInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkConditionalRenderingBeginInfoEXT.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkConditionalRenderingBeginInfoEXT.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkConditionalRenderingBeginInfoEXT mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkConditionalRenderingBeginInfoEXT mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkConditionalRenderingBeginInfoEXT.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkConditionalRenderingBeginInfoEXT.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
nbufferback to summary
public static long nbuffer(long struct)

Unsafe version of buffer.

nbufferback to summary
public static void nbuffer(long struct, long value)

Unsafe version of buffer.

nflagsback to summary
public static int nflags(long struct)

Unsafe version of flags.

nflagsback to summary
public static void nflags(long struct, int value)

Unsafe version of flags.

noffsetback to summary
public static long noffset(long struct)

Unsafe version of offset.

noffsetback to summary
public static void noffset(long struct, long value)

Unsafe version of offset.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

offsetback to summary
public long offset()

the byte offset into buffer where the predicate is located.

Annotations
@NativeType:VkDeviceSize
offsetback to summary
public VkConditionalRenderingBeginInfoEXT offset(long value)

Sets the specified value to the offset field.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkConditionalRenderingBeginInfoEXT pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkConditionalRenderingBeginInfoEXT set(int sType, long pNext, long buffer, long offset, int flags)

Initializes this struct with the specified values.

setback to summary
public VkConditionalRenderingBeginInfoEXT set(VkConditionalRenderingBeginInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkConditionalRenderingBeginInfoEXT

the source struct

Returns:VkConditionalRenderingBeginInfoEXT

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkConditionalRenderingBeginInfoEXT sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkConditionalRenderingBeginInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_CONDITIONAL_RENDERING_BEGIN_INFO_EXT value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkConditionalRenderingBeginInfoEXT.Buffer

extends StructBuffer<VkConditionalRenderingBeginInfoEXT, VkConditionalRenderingBeginInfoEXT.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkConditionalRenderingBeginInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkConditionalRenderingBeginInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkConditionalRenderingBeginInfoEXT.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

the value of the VkConditionalRenderingBeginInfoEXT#buffer field.
buffer
()

public VkConditionalRenderingBeginInfoEXT.Buffer
buffer(long value)

Sets the specified value to the VkConditionalRenderingBeginInfoEXT#buffer field.

public int

Returns:

the value of the VkConditionalRenderingBeginInfoEXT#flags field.
flags
()

public VkConditionalRenderingBeginInfoEXT.Buffer
flags(int value)

Sets the specified value to the VkConditionalRenderingBeginInfoEXT#flags field.

protected VkConditionalRenderingBeginInfoEXT
public long

Returns:

the value of the VkConditionalRenderingBeginInfoEXT#offset field.
offset
()

public VkConditionalRenderingBeginInfoEXT.Buffer
offset(long value)

Sets the specified value to the VkConditionalRenderingBeginInfoEXT#offset field.

public long

Returns:

the value of the VkConditionalRenderingBeginInfoEXT#pNext field.
pNext
()

public VkConditionalRenderingBeginInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkConditionalRenderingBeginInfoEXT#pNext field.

protected VkConditionalRenderingBeginInfoEXT.Buffer
public int

Returns:

the value of the VkConditionalRenderingBeginInfoEXT#sType field.
sType
()

public VkConditionalRenderingBeginInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkConditionalRenderingBeginInfoEXT#sType field.

public VkConditionalRenderingBeginInfoEXT.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkConditionalRenderingBeginInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkConditionalRenderingBeginInfoEXT.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkConditionalRenderingBeginInfoEXT#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

bufferback to summary
public long buffer()
Returns:long

the value of the VkConditionalRenderingBeginInfoEXT#buffer field.

Annotations
@NativeType:VkBuffer
bufferback to summary
public VkConditionalRenderingBeginInfoEXT.Buffer buffer(long value)

Sets the specified value to the VkConditionalRenderingBeginInfoEXT#buffer field.

flagsback to summary
public int flags()
Returns:int

the value of the VkConditionalRenderingBeginInfoEXT#flags field.

Annotations
@NativeType:VkConditionalRenderingFlagsEXT
flagsback to summary
public VkConditionalRenderingBeginInfoEXT.Buffer flags(int value)

Sets the specified value to the VkConditionalRenderingBeginInfoEXT#flags field.

getElementFactoryback to summary
protected VkConditionalRenderingBeginInfoEXT getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
offsetback to summary
public long offset()
Returns:long

the value of the VkConditionalRenderingBeginInfoEXT#offset field.

Annotations
@NativeType:VkDeviceSize
offsetback to summary
public VkConditionalRenderingBeginInfoEXT.Buffer offset(long value)

Sets the specified value to the VkConditionalRenderingBeginInfoEXT#offset field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkConditionalRenderingBeginInfoEXT#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkConditionalRenderingBeginInfoEXT.Buffer pNext(long value)

Sets the specified value to the VkConditionalRenderingBeginInfoEXT#pNext field.

selfback to summary
protected VkConditionalRenderingBeginInfoEXT.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkConditionalRenderingBeginInfoEXT#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkConditionalRenderingBeginInfoEXT.Buffer sType(int value)

Sets the specified value to the VkConditionalRenderingBeginInfoEXT#sType field.

sType$Defaultback to summary
public VkConditionalRenderingBeginInfoEXT.Buffer sType$Default()

Sets the STRUCTURE_TYPE_CONDITIONAL_RENDERING_BEGIN_INFO_EXT value to the VkConditionalRenderingBeginInfoEXT#sType field.