VkConditionalRenderingBeginInfoEXT (LWJGL 3.2.4 SNAPSHOT

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 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 single VkDeviceMemory object
- buffer must have been created with the BUFFER_USAGE_CONDITIONAL_RENDERING_BIT_EXT bit set
- offset must be less than the size of buffer by at least 32 bits.
- offset must be a multiple of 4
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_CONDITIONAL_RENDERING_BEGIN_INFO_EXT
- pNext must be NULL
- buffer must be a valid VkBuffer handle
- flags must be a valid combination of VkConditionalRenderingFlagBitsEXT 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 into buffer where the predicate is located.
- flags – a bitmask of VkConditionalRenderingFlagsEXT 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 and Description

static class VkConditionalRenderingBeginInfoEXT.Buffer
An array of VkConditionalRenderingBeginInfoEXT structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkConditionalRenderingBeginInfoEXT.Buffer` An array of `VkConditionalRenderingBeginInfoEXT` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`BUFFER` The struct member offsets.
`static int`	`FLAGS` The struct member offsets.
`static int`	`OFFSET` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STYPE` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkConditionalRenderingBeginInfoEXT(java.nio.ByteBuffer container)` Creates a `VkConditionalRenderingBeginInfoEXT` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`buffer()` Returns the value of the `buffer` field.
`VkConditionalRenderingBeginInfoEXT`	`buffer(long value)` Sets the specified value to the `buffer` field.
`static VkConditionalRenderingBeginInfoEXT`	`calloc()` Returns a new `VkConditionalRenderingBeginInfoEXT` instance allocated with `memCalloc`.
`static VkConditionalRenderingBeginInfoEXT.Buffer`	`calloc(int capacity)` Returns a new `VkConditionalRenderingBeginInfoEXT.Buffer` instance allocated with `memCalloc`.
`static VkConditionalRenderingBeginInfoEXT`	`callocStack()` Returns a new `VkConditionalRenderingBeginInfoEXT` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkConditionalRenderingBeginInfoEXT.Buffer`	`callocStack(int capacity)` Returns a new `VkConditionalRenderingBeginInfoEXT.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkConditionalRenderingBeginInfoEXT.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkConditionalRenderingBeginInfoEXT.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkConditionalRenderingBeginInfoEXT`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkConditionalRenderingBeginInfoEXT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkConditionalRenderingBeginInfoEXT`	`create()` Returns a new `VkConditionalRenderingBeginInfoEXT` instance allocated with `BufferUtils`.
`static VkConditionalRenderingBeginInfoEXT.Buffer`	`create(int capacity)` Returns a new `VkConditionalRenderingBeginInfoEXT.Buffer` instance allocated with `BufferUtils`.
`static VkConditionalRenderingBeginInfoEXT`	`create(long address)` Returns a new `VkConditionalRenderingBeginInfoEXT` instance for the specified memory address.
`static VkConditionalRenderingBeginInfoEXT.Buffer`	`create(long address, int capacity)` Create a `VkConditionalRenderingBeginInfoEXT.Buffer` instance at the specified memory.
`static VkConditionalRenderingBeginInfoEXT`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkConditionalRenderingBeginInfoEXT.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`flags()` Returns the value of the `flags` field.
`VkConditionalRenderingBeginInfoEXT`	`flags(int value)` Sets the specified value to the `flags` field.
`static VkConditionalRenderingBeginInfoEXT`	`malloc()` Returns a new `VkConditionalRenderingBeginInfoEXT` instance allocated with `memAlloc`.
`static VkConditionalRenderingBeginInfoEXT.Buffer`	`malloc(int capacity)` Returns a new `VkConditionalRenderingBeginInfoEXT.Buffer` instance allocated with `memAlloc`.
`static VkConditionalRenderingBeginInfoEXT`	`mallocStack()` Returns a new `VkConditionalRenderingBeginInfoEXT` instance allocated on the thread-local `MemoryStack`.
`static VkConditionalRenderingBeginInfoEXT.Buffer`	`mallocStack(int capacity)` Returns a new `VkConditionalRenderingBeginInfoEXT.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkConditionalRenderingBeginInfoEXT.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkConditionalRenderingBeginInfoEXT.Buffer` instance allocated on the specified `MemoryStack`.
`static VkConditionalRenderingBeginInfoEXT`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkConditionalRenderingBeginInfoEXT` instance allocated on the specified `MemoryStack`.
`static long`	`nbuffer(long struct)` Unsafe version of `buffer()`.
`static void`	`nbuffer(long struct, long value)` Unsafe version of `buffer`.
`static int`	`nflags(long struct)` Unsafe version of `flags()`.
`static void`	`nflags(long struct, int value)` Unsafe version of `flags`.
`static long`	`noffset(long struct)` Unsafe version of `offset()`.
`static void`	`noffset(long struct, long value)` Unsafe version of `offset`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`long`	`offset()` Returns the value of the `offset` field.
`VkConditionalRenderingBeginInfoEXT`	`offset(long value)` Sets the specified value to the `offset` field.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkConditionalRenderingBeginInfoEXT`	`pNext(long value)` Sets the specified value to the `pNext` 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 the `sType` field.
`VkConditionalRenderingBeginInfoEXT`	`sType(int value)` Sets the specified value to the `sType` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - STYPE
```
public static final int STYPE
```
    The struct member offsets.
  - PNEXT
```
public static final int PNEXT
```
    The struct member offsets.
  - BUFFER
```
public static final int BUFFER
```
    The struct member offsets.
  - OFFSET
```
public static final int OFFSET
```
    The struct member offsets.
  - FLAGS
```
public static final int FLAGS
```
    The struct member offsets.
- Constructor Detail
  - VkConditionalRenderingBeginInfoEXT
```
public VkConditionalRenderingBeginInfoEXT(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - buffer
```
public long buffer()
```
    Returns the value of the buffer field.
  - offset
```
public long offset()
```
    Returns the value of the offset field.
  - flags
```
public int flags()
```
    Returns the value of the flags field.
  - sType
```
public VkConditionalRenderingBeginInfoEXT sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkConditionalRenderingBeginInfoEXT pNext(long value)
```
    Sets the specified value to the pNext field.
  - buffer
```
public VkConditionalRenderingBeginInfoEXT buffer(long value)
```
    Sets the specified value to the buffer field.
  - offset
```
public VkConditionalRenderingBeginInfoEXT offset(long value)
```
    Sets the specified value to the offset field.
  - flags
```
public VkConditionalRenderingBeginInfoEXT flags(int value)
```
    Sets the specified value to the flags 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 new VkConditionalRenderingBeginInfoEXT instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkConditionalRenderingBeginInfoEXT calloc()
```
    Returns a new VkConditionalRenderingBeginInfoEXT instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkConditionalRenderingBeginInfoEXT create()
```
    Returns a new VkConditionalRenderingBeginInfoEXT instance allocated with BufferUtils.
  - create
```
public static VkConditionalRenderingBeginInfoEXT create(long address)
```
    Returns a new VkConditionalRenderingBeginInfoEXT instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkConditionalRenderingBeginInfoEXT createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkConditionalRenderingBeginInfoEXT.Buffer malloc(int capacity)
```
    Returns a new VkConditionalRenderingBeginInfoEXT.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkConditionalRenderingBeginInfoEXT.Buffer calloc(int capacity)
```
    Returns a new VkConditionalRenderingBeginInfoEXT.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkConditionalRenderingBeginInfoEXT.Buffer create(int capacity)
```
    Returns a new VkConditionalRenderingBeginInfoEXT.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkConditionalRenderingBeginInfoEXT.Buffer create(long address,
                                                               int capacity)
```
    Create a VkConditionalRenderingBeginInfoEXT.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkConditionalRenderingBeginInfoEXT.Buffer createSafe(long address,
                                                                             int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkConditionalRenderingBeginInfoEXT mallocStack()
```
    Returns a new VkConditionalRenderingBeginInfoEXT instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkConditionalRenderingBeginInfoEXT callocStack()
```
    Returns a new VkConditionalRenderingBeginInfoEXT instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkConditionalRenderingBeginInfoEXT mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkConditionalRenderingBeginInfoEXT instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkConditionalRenderingBeginInfoEXT callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkConditionalRenderingBeginInfoEXT instance allocated on the specified MemoryStack 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 new VkConditionalRenderingBeginInfoEXT.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkConditionalRenderingBeginInfoEXT.Buffer callocStack(int capacity)
```
    Returns a new VkConditionalRenderingBeginInfoEXT.Buffer instance allocated on the thread-local MemoryStack 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 new VkConditionalRenderingBeginInfoEXT.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkConditionalRenderingBeginInfoEXT.Buffer callocStack(int capacity,
                                                                    org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkConditionalRenderingBeginInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - nbuffer
```
public static long nbuffer(long struct)
```
    Unsafe version of buffer().
  - noffset
```
public static long noffset(long struct)
```
    Unsafe version of offset().
  - nflags
```
public static int nflags(long struct)
```
    Unsafe version of flags().
  - nsType
```
public static void nsType(long struct,
                          int value)
```
    Unsafe version of sType.
  - npNext
```
public static void npNext(long struct,
                          long value)
```
    Unsafe version of pNext.
  - nbuffer
```
public static void nbuffer(long struct,
                           long value)
```
    Unsafe version of buffer.
  - noffset
```
public static void noffset(long struct,
                           long value)
```
    Unsafe version of offset.
  - nflags
```
public static void nflags(long struct,
                          int value)
```
    Unsafe version of flags.

Class VkConditionalRenderingBeginInfoEXT

Description

Valid Usage

Valid Usage (Implicit)

See Also

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

BUFFER

OFFSET

FLAGS

Constructor Detail

VkConditionalRenderingBeginInfoEXT

Method Detail

sizeof

sType

pNext

buffer

offset

flags

sType

pNext

buffer

offset

flags

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nbuffer

noffset

nflags

nsType

npNext

nbuffer

noffset

nflags