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.NativeResourceSet the initial device mask and render areas for a render pass instance.Description
The
deviceMaskserves 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 a 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
deviceRenderAreaCountis not zero, then the elements ofpDeviceRenderAreasoverride 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_CLEARand 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 ifdeviceRenderAreaCountis zero,VkRenderPassBeginInfo::renderAreais used for all physical devices.Valid Usage
deviceMaskmust be a valid device mask valuedeviceMaskmust not be zerodeviceMaskmust be a subset of the command buffer’s initial device maskdeviceRenderAreaCountmust either be zero or equal to the number of physical devices in the logical device- The
offset.xmember of any element ofpDeviceRenderAreasmust be greater than or equal to 0 - The
offset.ymember of any element ofpDeviceRenderAreasmust be greater than or equal to 0 - The sum of the
offset.xandextent.widthmembers of any element ofpDeviceRenderAreasmust be less than or equal tomaxFramebufferWidth - The sum of the
offset.yandextent.heightmembers of any element ofpDeviceRenderAreasmust be less than or equal tomaxFramebufferHeight
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_DEVICE_GROUP_RENDER_PASS_BEGIN_INFO- If
deviceRenderAreaCountis not 0,pDeviceRenderAreasmust be a valid pointer to an array ofdeviceRenderAreaCountVkRect2Dstructures
See Also
Layout
struct VkDeviceGroupRenderPassBeginInfo { VkStructureTypesType(); void const *pNext(); uint32_tdeviceMask(); uint32_tdeviceRenderAreaCount();VkRect2Dconst *pDeviceRenderAreas(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkDeviceGroupRenderPassBeginInfo.BufferAn array ofVkDeviceGroupRenderPassBeginInfostructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intDEVICEMASK
DEVICERENDERAREACOUNT
PDEVICERENDERAREAS
PNEXTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkDeviceGroupRenderPassBeginInfo(java.nio.ByteBuffer container)Creates aVkDeviceGroupRenderPassBeginInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static VkDeviceGroupRenderPassBeginInfocalloc()Returns a newVkDeviceGroupRenderPassBeginInfoinstance allocated withmemCalloc.static VkDeviceGroupRenderPassBeginInfo.Buffercalloc(int capacity)Returns a newVkDeviceGroupRenderPassBeginInfo.Bufferinstance allocated withmemCalloc.static VkDeviceGroupRenderPassBeginInfo.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkDeviceGroupRenderPassBeginInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDeviceGroupRenderPassBeginInfocalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkDeviceGroupRenderPassBeginInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDeviceGroupRenderPassBeginInfocallocStack()Deprecated.static VkDeviceGroupRenderPassBeginInfo.BuffercallocStack(int capacity)Deprecated.static VkDeviceGroupRenderPassBeginInfo.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkDeviceGroupRenderPassBeginInfocallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static VkDeviceGroupRenderPassBeginInfocreate()Returns a newVkDeviceGroupRenderPassBeginInfoinstance allocated withBufferUtils.static VkDeviceGroupRenderPassBeginInfo.Buffercreate(int capacity)Returns a newVkDeviceGroupRenderPassBeginInfo.Bufferinstance allocated withBufferUtils.static VkDeviceGroupRenderPassBeginInfocreate(long address)Returns a newVkDeviceGroupRenderPassBeginInfoinstance for the specified memory address.static VkDeviceGroupRenderPassBeginInfo.Buffercreate(long address, int capacity)Create aVkDeviceGroupRenderPassBeginInfo.Bufferinstance at the specified memory.static VkDeviceGroupRenderPassBeginInfocreateSafe(long address)static VkDeviceGroupRenderPassBeginInfo.BuffercreateSafe(long address, int capacity)intdeviceMask()the device mask for the render pass instance.VkDeviceGroupRenderPassBeginInfodeviceMask(int value)Sets the specified value to thedeviceMask()field.intdeviceRenderAreaCount()the number of elements in thepDeviceRenderAreasarray.static VkDeviceGroupRenderPassBeginInfomalloc()Returns a newVkDeviceGroupRenderPassBeginInfoinstance allocated withmemAlloc.static VkDeviceGroupRenderPassBeginInfo.Buffermalloc(int capacity)Returns a newVkDeviceGroupRenderPassBeginInfo.Bufferinstance allocated withmemAlloc.static VkDeviceGroupRenderPassBeginInfo.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkDeviceGroupRenderPassBeginInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkDeviceGroupRenderPassBeginInfomalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkDeviceGroupRenderPassBeginInfoinstance allocated on the specifiedMemoryStack.static VkDeviceGroupRenderPassBeginInfomallocStack()Deprecated.static VkDeviceGroupRenderPassBeginInfo.BuffermallocStack(int capacity)Deprecated.static VkDeviceGroupRenderPassBeginInfo.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkDeviceGroupRenderPassBeginInfomallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static intndeviceMask(long struct)Unsafe version ofdeviceMask().static voidndeviceMask(long struct, int value)Unsafe version ofdeviceMask.static intndeviceRenderAreaCount(long struct)Unsafe version ofdeviceRenderAreaCount().static voidndeviceRenderAreaCount(long struct, int value)Sets the specified value to thedeviceRenderAreaCountfield of the specifiedstruct.static VkRect2D.BuffernpDeviceRenderAreas(long struct)Unsafe version ofpDeviceRenderAreas().static voidnpDeviceRenderAreas(long struct, VkRect2D.Buffer value)Unsafe version ofpDeviceRenderAreas.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.VkRect2D.BufferpDeviceRenderAreas()a pointer to an array ofVkRect2Dstructures defining the render area for each physical device.VkDeviceGroupRenderPassBeginInfopDeviceRenderAreas(VkRect2D.Buffer value)Sets the address of the specifiedVkRect2D.Bufferto thepDeviceRenderAreas()field.longpNext()NULLor a pointer to a structure extending this structure.VkDeviceGroupRenderPassBeginInfopNext(long value)Sets the specified value to thepNext()field.VkDeviceGroupRenderPassBeginInfoset(int sType, long pNext, int deviceMask, VkRect2D.Buffer pDeviceRenderAreas)Initializes this struct with the specified values.VkDeviceGroupRenderPassBeginInfoset(VkDeviceGroupRenderPassBeginInfo src)Copies the specified struct data to this struct.intsizeof()intsType()the type of this structure.VkDeviceGroupRenderPassBeginInfosType(int value)Sets the specified value to thesType()field.VkDeviceGroupRenderPassBeginInfosType$Default()Sets theSTRUCTURE_TYPE_DEVICE_GROUP_RENDER_PASS_BEGIN_INFOvalue to thesType()field.static voidvalidate(long struct)Validates pointer members that should not beNULL.
-
-
-
Constructor Detail
-
VkDeviceGroupRenderPassBeginInfo
public VkDeviceGroupRenderPassBeginInfo(java.nio.ByteBuffer container)
Creates aVkDeviceGroupRenderPassBeginInfoinstance 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.
-
deviceMask
public int deviceMask()
the device mask for the render pass instance.
-
deviceRenderAreaCount
public int deviceRenderAreaCount()
the number of elements in thepDeviceRenderAreasarray.
-
pDeviceRenderAreas
@Nullable public VkRect2D.Buffer pDeviceRenderAreas()
a pointer to an array ofVkRect2Dstructures defining the render area for each physical device.
-
sType
public VkDeviceGroupRenderPassBeginInfo sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkDeviceGroupRenderPassBeginInfo sType$Default()
Sets theSTRUCTURE_TYPE_DEVICE_GROUP_RENDER_PASS_BEGIN_INFOvalue 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.Bufferto 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 newVkDeviceGroupRenderPassBeginInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkDeviceGroupRenderPassBeginInfo calloc()
Returns a newVkDeviceGroupRenderPassBeginInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkDeviceGroupRenderPassBeginInfo create()
Returns a newVkDeviceGroupRenderPassBeginInfoinstance allocated withBufferUtils.
-
create
public static VkDeviceGroupRenderPassBeginInfo create(long address)
Returns a newVkDeviceGroupRenderPassBeginInfoinstance for the specified memory address.
-
createSafe
@Nullable public static VkDeviceGroupRenderPassBeginInfo createSafe(long address)
-
malloc
public static VkDeviceGroupRenderPassBeginInfo.Buffer malloc(int capacity)
Returns a newVkDeviceGroupRenderPassBeginInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkDeviceGroupRenderPassBeginInfo.Buffer calloc(int capacity)
Returns a newVkDeviceGroupRenderPassBeginInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkDeviceGroupRenderPassBeginInfo.Buffer create(int capacity)
Returns a newVkDeviceGroupRenderPassBeginInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkDeviceGroupRenderPassBeginInfo.Buffer create(long address, int capacity)
Create aVkDeviceGroupRenderPassBeginInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkDeviceGroupRenderPassBeginInfo.Buffer createSafe(long address, int capacity)
-
mallocStack
@Deprecated public static VkDeviceGroupRenderPassBeginInfo mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkDeviceGroupRenderPassBeginInfo callocStack()
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkDeviceGroupRenderPassBeginInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkDeviceGroupRenderPassBeginInfo callocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkDeviceGroupRenderPassBeginInfo.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkDeviceGroupRenderPassBeginInfo.Buffer callocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
mallocStack
@Deprecated public static VkDeviceGroupRenderPassBeginInfo.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 VkDeviceGroupRenderPassBeginInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
malloc
public static VkDeviceGroupRenderPassBeginInfo malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkDeviceGroupRenderPassBeginInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkDeviceGroupRenderPassBeginInfo calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkDeviceGroupRenderPassBeginInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkDeviceGroupRenderPassBeginInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDeviceGroupRenderPassBeginInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkDeviceGroupRenderPassBeginInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDeviceGroupRenderPassBeginInfo.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().
-
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 thedeviceRenderAreaCountfield 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
-
-