Class VkDeviceGroupRenderPassBeginInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkDeviceGroupRenderPassBeginInfo
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkDeviceGroupRenderPassBeginInfoKHR
public class VkDeviceGroupRenderPassBeginInfo extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Set the initial device mask and render areas for a render pass instance.Description
The
deviceMask
serves several purposes. It is an upper bound on the set of physical devices that can be used during the render pass instance, and the initial device mask when the render pass instance begins. In addition, commands transitioning to the next subpass in the render pass instance and commands ending the render pass instance, and, accordingly render pass attachment load, store, and resolve operations and subpass dependencies corresponding to the render pass instance, are executed on the physical devices included in the device mask provided here.If
deviceRenderAreaCount
is not zero, then the elements ofpDeviceRenderAreas
override the value ofVkRenderPassBeginInfo
::renderArea
, and provide a render area specific to each physical device. These render areas serve the same purpose asVkRenderPassBeginInfo
::renderArea
, including controlling the region of attachments that are cleared byATTACHMENT_LOAD_OP_CLEAR
and that are resolved into resolve attachments.If this structure is not present, the render pass instance's device mask is the value of
VkDeviceGroupCommandBufferBeginInfo
::deviceMask
. If this structure is not present or ifdeviceRenderAreaCount
is zero,VkRenderPassBeginInfo
::renderArea
is used for all physical devices.Valid Usage
deviceMask
must be a valid device mask valuedeviceMask
must not be zerodeviceMask
must be a subset of the command buffer’s initial device maskdeviceRenderAreaCount
must either be zero or equal to the number of physical devices in the logical device.
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_DEVICE_GROUP_RENDER_PASS_BEGIN_INFO
- If
deviceRenderAreaCount
is not 0,pDeviceRenderAreas
must be a valid pointer to an array ofdeviceRenderAreaCount
VkRect2D
structures
See Also
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.deviceMask
– the device mask for the render pass instance.deviceRenderAreaCount
– the number of elements in thepDeviceRenderAreas
array.pDeviceRenderAreas
– an array of structures of typeVkRect2D
defining the render area for each physical device.
Layout
struct VkDeviceGroupRenderPassBeginInfo { VkStructureType sType; void const * pNext; uint32_t deviceMask; uint32_t deviceRenderAreaCount;
VkRect2D
const * pDeviceRenderAreas; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkDeviceGroupRenderPassBeginInfo.Buffer
An array ofVkDeviceGroupRenderPassBeginInfo
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
DEVICEMASK
DEVICERENDERAREACOUNT
PDEVICERENDERAREAS
PNEXTThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STYPE
The struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkDeviceGroupRenderPassBeginInfo(java.nio.ByteBuffer container)
Creates aVkDeviceGroupRenderPassBeginInfo
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkDeviceGroupRenderPassBeginInfo
calloc()
Returns a newVkDeviceGroupRenderPassBeginInfo
instance allocated withmemCalloc
.static VkDeviceGroupRenderPassBeginInfo.Buffer
calloc(int capacity)
Returns a newVkDeviceGroupRenderPassBeginInfo.Buffer
instance allocated withmemCalloc
.static VkDeviceGroupRenderPassBeginInfo
callocStack()
Returns a newVkDeviceGroupRenderPassBeginInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDeviceGroupRenderPassBeginInfo.Buffer
callocStack(int capacity)
Returns a newVkDeviceGroupRenderPassBeginInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDeviceGroupRenderPassBeginInfo.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDeviceGroupRenderPassBeginInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDeviceGroupRenderPassBeginInfo
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDeviceGroupRenderPassBeginInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDeviceGroupRenderPassBeginInfo
create()
Returns a newVkDeviceGroupRenderPassBeginInfo
instance allocated withBufferUtils
.static VkDeviceGroupRenderPassBeginInfo.Buffer
create(int capacity)
Returns a newVkDeviceGroupRenderPassBeginInfo.Buffer
instance allocated withBufferUtils
.static VkDeviceGroupRenderPassBeginInfo
create(long address)
Returns a newVkDeviceGroupRenderPassBeginInfo
instance for the specified memory address.static VkDeviceGroupRenderPassBeginInfo.Buffer
create(long address, int capacity)
Create aVkDeviceGroupRenderPassBeginInfo.Buffer
instance at the specified memory.static VkDeviceGroupRenderPassBeginInfo
createSafe(long address)
static VkDeviceGroupRenderPassBeginInfo.Buffer
createSafe(long address, int capacity)
int
deviceMask()
Returns the value of thedeviceMask
field.VkDeviceGroupRenderPassBeginInfo
deviceMask(int value)
Sets the specified value to thedeviceMask
field.int
deviceRenderAreaCount()
Returns the value of thedeviceRenderAreaCount
field.static VkDeviceGroupRenderPassBeginInfo
malloc()
Returns a newVkDeviceGroupRenderPassBeginInfo
instance allocated withmemAlloc
.static VkDeviceGroupRenderPassBeginInfo.Buffer
malloc(int capacity)
Returns a newVkDeviceGroupRenderPassBeginInfo.Buffer
instance allocated withmemAlloc
.static VkDeviceGroupRenderPassBeginInfo
mallocStack()
Returns a newVkDeviceGroupRenderPassBeginInfo
instance allocated on the thread-localMemoryStack
.static VkDeviceGroupRenderPassBeginInfo.Buffer
mallocStack(int capacity)
Returns a newVkDeviceGroupRenderPassBeginInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkDeviceGroupRenderPassBeginInfo.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDeviceGroupRenderPassBeginInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkDeviceGroupRenderPassBeginInfo
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDeviceGroupRenderPassBeginInfo
instance allocated on the specifiedMemoryStack
.static int
ndeviceMask(long struct)
Unsafe version ofdeviceMask()
.static void
ndeviceMask(long struct, int value)
Unsafe version ofdeviceMask
.static int
ndeviceRenderAreaCount(long struct)
Unsafe version ofdeviceRenderAreaCount()
.static void
ndeviceRenderAreaCount(long struct, int value)
Sets the specified value to thedeviceRenderAreaCount
field of the specifiedstruct
.static VkRect2D.Buffer
npDeviceRenderAreas(long struct)
Unsafe version ofpDeviceRenderAreas()
.static void
npDeviceRenderAreas(long struct, VkRect2D.Buffer value)
Unsafe version ofpDeviceRenderAreas
.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
.VkRect2D.Buffer
pDeviceRenderAreas()
Returns aVkRect2D.Buffer
view of the struct array pointed to by thepDeviceRenderAreas
field.VkDeviceGroupRenderPassBeginInfo
pDeviceRenderAreas(VkRect2D.Buffer value)
Sets the address of the specifiedVkRect2D.Buffer
to thepDeviceRenderAreas
field.long
pNext()
Returns the value of thepNext
field.VkDeviceGroupRenderPassBeginInfo
pNext(long value)
Sets the specified value to thepNext
field.VkDeviceGroupRenderPassBeginInfo
set(int sType, long pNext, int deviceMask, VkRect2D.Buffer pDeviceRenderAreas)
Initializes this struct with the specified values.VkDeviceGroupRenderPassBeginInfo
set(VkDeviceGroupRenderPassBeginInfo src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkDeviceGroupRenderPassBeginInfo
sType(int value)
Sets the specified value to thesType
field.static void
validate(long struct)
Validates pointer members that should not beNULL
.static void
validate(long array, int count)
Callsvalidate(long)
for each struct contained in the specified struct array.
-
-
-
Constructor Detail
-
VkDeviceGroupRenderPassBeginInfo
public VkDeviceGroupRenderPassBeginInfo(java.nio.ByteBuffer container)
Creates aVkDeviceGroupRenderPassBeginInfo
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.
-
deviceMask
public int deviceMask()
Returns the value of thedeviceMask
field.
-
deviceRenderAreaCount
public int deviceRenderAreaCount()
Returns the value of thedeviceRenderAreaCount
field.
-
pDeviceRenderAreas
@Nullable public VkRect2D.Buffer pDeviceRenderAreas()
Returns aVkRect2D.Buffer
view of the struct array pointed to by thepDeviceRenderAreas
field.
-
sType
public VkDeviceGroupRenderPassBeginInfo sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkDeviceGroupRenderPassBeginInfo pNext(long value)
Sets the specified value to thepNext
field.
-
deviceMask
public VkDeviceGroupRenderPassBeginInfo deviceMask(int value)
Sets the specified value to thedeviceMask
field.
-
pDeviceRenderAreas
public VkDeviceGroupRenderPassBeginInfo pDeviceRenderAreas(@Nullable VkRect2D.Buffer value)
Sets the address of the specifiedVkRect2D.Buffer
to thepDeviceRenderAreas
field.
-
set
public VkDeviceGroupRenderPassBeginInfo set(int sType, long pNext, int deviceMask, @Nullable VkRect2D.Buffer pDeviceRenderAreas)
Initializes this struct with the specified values.
-
set
public VkDeviceGroupRenderPassBeginInfo set(VkDeviceGroupRenderPassBeginInfo src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkDeviceGroupRenderPassBeginInfo malloc()
Returns a newVkDeviceGroupRenderPassBeginInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkDeviceGroupRenderPassBeginInfo calloc()
Returns a newVkDeviceGroupRenderPassBeginInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkDeviceGroupRenderPassBeginInfo create()
Returns a newVkDeviceGroupRenderPassBeginInfo
instance allocated withBufferUtils
.
-
create
public static VkDeviceGroupRenderPassBeginInfo create(long address)
Returns a newVkDeviceGroupRenderPassBeginInfo
instance for the specified memory address.
-
createSafe
@Nullable public static VkDeviceGroupRenderPassBeginInfo createSafe(long address)
-
malloc
public static VkDeviceGroupRenderPassBeginInfo.Buffer malloc(int capacity)
Returns a newVkDeviceGroupRenderPassBeginInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkDeviceGroupRenderPassBeginInfo.Buffer calloc(int capacity)
Returns a newVkDeviceGroupRenderPassBeginInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDeviceGroupRenderPassBeginInfo.Buffer create(int capacity)
Returns a newVkDeviceGroupRenderPassBeginInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDeviceGroupRenderPassBeginInfo.Buffer create(long address, int capacity)
Create aVkDeviceGroupRenderPassBeginInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkDeviceGroupRenderPassBeginInfo.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkDeviceGroupRenderPassBeginInfo mallocStack()
Returns a newVkDeviceGroupRenderPassBeginInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkDeviceGroupRenderPassBeginInfo callocStack()
Returns a newVkDeviceGroupRenderPassBeginInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkDeviceGroupRenderPassBeginInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDeviceGroupRenderPassBeginInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkDeviceGroupRenderPassBeginInfo callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDeviceGroupRenderPassBeginInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkDeviceGroupRenderPassBeginInfo.Buffer mallocStack(int capacity)
Returns a newVkDeviceGroupRenderPassBeginInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkDeviceGroupRenderPassBeginInfo.Buffer callocStack(int capacity)
Returns a newVkDeviceGroupRenderPassBeginInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkDeviceGroupRenderPassBeginInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDeviceGroupRenderPassBeginInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkDeviceGroupRenderPassBeginInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDeviceGroupRenderPassBeginInfo.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()
.
-
ndeviceMask
public static int ndeviceMask(long struct)
Unsafe version ofdeviceMask()
.
-
ndeviceRenderAreaCount
public static int ndeviceRenderAreaCount(long struct)
Unsafe version ofdeviceRenderAreaCount()
.
-
npDeviceRenderAreas
@Nullable public static VkRect2D.Buffer npDeviceRenderAreas(long struct)
Unsafe version ofpDeviceRenderAreas()
.
-
nsType
public static void nsType(long struct, int value)
Unsafe version ofsType
.
-
npNext
public static void npNext(long struct, long value)
Unsafe version ofpNext
.
-
ndeviceMask
public static void ndeviceMask(long struct, int value)
Unsafe version ofdeviceMask
.
-
ndeviceRenderAreaCount
public static void ndeviceRenderAreaCount(long struct, int value)
Sets the specified value to thedeviceRenderAreaCount
field of the specifiedstruct
.
-
npDeviceRenderAreas
public static void npDeviceRenderAreas(long struct, @Nullable VkRect2D.Buffer value)
Unsafe version ofpDeviceRenderAreas
.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL
.- Parameters:
struct
- the struct to validate
-
validate
public static void validate(long array, int count)
Callsvalidate(long)
for each struct contained in the specified struct array.- Parameters:
array
- the struct array to validatecount
- the number of structs inarray
-
-