VkDeviceGroupRenderPassBeginInfo (LWJGL 3.2.4 SNAPSHOT

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 of pDeviceRenderAreas override the value of VkRenderPassBeginInfo::renderArea, and provide a render area specific to each physical device. These render areas serve the same purpose as VkRenderPassBeginInfo::renderArea, including controlling the region of attachments that are cleared by ATTACHMENT_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 if deviceRenderAreaCount is zero, VkRenderPassBeginInfo::renderArea is used for all physical devices.

Valid Usage
- deviceMask must be a valid device mask value
- deviceMask must not be zero
- deviceMask must be a subset of the command buffer’s initial device mask
- deviceRenderAreaCount must either be zero or equal to the number of physical devices in the logical device.
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_DEVICE_GROUP_RENDER_PASS_BEGIN_INFO
- If deviceRenderAreaCount is not 0, pDeviceRenderAreas must be a valid pointer to an array of deviceRenderAreaCount VkRect2D structures
See Also

VkRect2D

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 the pDeviceRenderAreas array.
- pDeviceRenderAreas – a pointer to an array of VkRect2D structures 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 and Description

static class VkDeviceGroupRenderPassBeginInfo.Buffer
An array of VkDeviceGroupRenderPassBeginInfo 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`	`VkDeviceGroupRenderPassBeginInfo.Buffer` An array of `VkDeviceGroupRenderPassBeginInfo` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`DEVICEMASK` The struct member offsets.
`static int`	`DEVICERENDERAREACOUNT` The struct member offsets.
`static int`	`PDEVICERENDERAREAS` 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
`VkDeviceGroupRenderPassBeginInfo(java.nio.ByteBuffer container)` Creates a `VkDeviceGroupRenderPassBeginInfo` 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
`static VkDeviceGroupRenderPassBeginInfo`	`calloc()` Returns a new `VkDeviceGroupRenderPassBeginInfo` instance allocated with `memCalloc`.
`static VkDeviceGroupRenderPassBeginInfo.Buffer`	`calloc(int capacity)` Returns a new `VkDeviceGroupRenderPassBeginInfo.Buffer` instance allocated with `memCalloc`.
`static VkDeviceGroupRenderPassBeginInfo`	`callocStack()` Returns a new `VkDeviceGroupRenderPassBeginInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDeviceGroupRenderPassBeginInfo.Buffer`	`callocStack(int capacity)` Returns a new `VkDeviceGroupRenderPassBeginInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDeviceGroupRenderPassBeginInfo.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkDeviceGroupRenderPassBeginInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDeviceGroupRenderPassBeginInfo`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkDeviceGroupRenderPassBeginInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDeviceGroupRenderPassBeginInfo`	`create()` Returns a new `VkDeviceGroupRenderPassBeginInfo` instance allocated with `BufferUtils`.
`static VkDeviceGroupRenderPassBeginInfo.Buffer`	`create(int capacity)` Returns a new `VkDeviceGroupRenderPassBeginInfo.Buffer` instance allocated with `BufferUtils`.
`static VkDeviceGroupRenderPassBeginInfo`	`create(long address)` Returns a new `VkDeviceGroupRenderPassBeginInfo` instance for the specified memory address.
`static VkDeviceGroupRenderPassBeginInfo.Buffer`	`create(long address, int capacity)` Create a `VkDeviceGroupRenderPassBeginInfo.Buffer` instance at the specified memory.
`static VkDeviceGroupRenderPassBeginInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkDeviceGroupRenderPassBeginInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`deviceMask()` Returns the value of the `deviceMask` field.
`VkDeviceGroupRenderPassBeginInfo`	`deviceMask(int value)` Sets the specified value to the `deviceMask` field.
`int`	`deviceRenderAreaCount()` Returns the value of the `deviceRenderAreaCount` field.
`static VkDeviceGroupRenderPassBeginInfo`	`malloc()` Returns a new `VkDeviceGroupRenderPassBeginInfo` instance allocated with `memAlloc`.
`static VkDeviceGroupRenderPassBeginInfo.Buffer`	`malloc(int capacity)` Returns a new `VkDeviceGroupRenderPassBeginInfo.Buffer` instance allocated with `memAlloc`.
`static VkDeviceGroupRenderPassBeginInfo`	`mallocStack()` Returns a new `VkDeviceGroupRenderPassBeginInfo` instance allocated on the thread-local `MemoryStack`.
`static VkDeviceGroupRenderPassBeginInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VkDeviceGroupRenderPassBeginInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkDeviceGroupRenderPassBeginInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkDeviceGroupRenderPassBeginInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkDeviceGroupRenderPassBeginInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkDeviceGroupRenderPassBeginInfo` instance allocated on the specified `MemoryStack`.
`static int`	`ndeviceMask(long struct)` Unsafe version of `deviceMask()`.
`static void`	`ndeviceMask(long struct, int value)` Unsafe version of `deviceMask`.
`static int`	`ndeviceRenderAreaCount(long struct)` Unsafe version of `deviceRenderAreaCount()`.
`static void`	`ndeviceRenderAreaCount(long struct, int value)` Sets the specified value to the `deviceRenderAreaCount` field of the specified `struct`.
`static VkRect2D.Buffer`	`npDeviceRenderAreas(long struct)` Unsafe version of `pDeviceRenderAreas()`.
`static void`	`npDeviceRenderAreas(long struct, VkRect2D.Buffer value)` Unsafe version of `pDeviceRenderAreas`.
`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`.
`VkRect2D.Buffer`	`pDeviceRenderAreas()` Returns a `VkRect2D.Buffer` view of the struct array pointed to by the `pDeviceRenderAreas` field.
`VkDeviceGroupRenderPassBeginInfo`	`pDeviceRenderAreas(VkRect2D.Buffer value)` Sets the address of the specified `VkRect2D.Buffer` to the `pDeviceRenderAreas` field.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkDeviceGroupRenderPassBeginInfo`	`pNext(long value)` Sets the specified value to the `pNext` 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 the `sType` field.
`VkDeviceGroupRenderPassBeginInfo`	`sType(int value)` Sets the specified value to the `sType` field.
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.

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.
  - DEVICEMASK
```
public static final int DEVICEMASK
```
    The struct member offsets.
  - DEVICERENDERAREACOUNT
```
public static final int DEVICERENDERAREACOUNT
```
    The struct member offsets.
  - PDEVICERENDERAREAS
```
public static final int PDEVICERENDERAREAS
```
    The struct member offsets.
- Constructor Detail
  - VkDeviceGroupRenderPassBeginInfo
```
public VkDeviceGroupRenderPassBeginInfo(java.nio.ByteBuffer container)
```
    Creates a VkDeviceGroupRenderPassBeginInfo 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.
  - deviceMask
```
public int deviceMask()
```
    Returns the value of the deviceMask field.
  - deviceRenderAreaCount
```
public int deviceRenderAreaCount()
```
    Returns the value of the deviceRenderAreaCount field.
  - pDeviceRenderAreas
```
@Nullable
public VkRect2D.Buffer pDeviceRenderAreas()
```
    Returns a VkRect2D.Buffer view of the struct array pointed to by the pDeviceRenderAreas field.
  - sType
```
public VkDeviceGroupRenderPassBeginInfo sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkDeviceGroupRenderPassBeginInfo pNext(long value)
```
    Sets the specified value to the pNext field.
  - deviceMask
```
public VkDeviceGroupRenderPassBeginInfo deviceMask(int value)
```
    Sets the specified value to the deviceMask field.
  - pDeviceRenderAreas
```
public VkDeviceGroupRenderPassBeginInfo pDeviceRenderAreas(@Nullable
                                                           VkRect2D.Buffer value)
```
    Sets the address of the specified VkRect2D.Buffer to the pDeviceRenderAreas 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 new VkDeviceGroupRenderPassBeginInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkDeviceGroupRenderPassBeginInfo calloc()
```
    Returns a new VkDeviceGroupRenderPassBeginInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkDeviceGroupRenderPassBeginInfo create()
```
    Returns a new VkDeviceGroupRenderPassBeginInfo instance allocated with BufferUtils.
  - create
```
public static VkDeviceGroupRenderPassBeginInfo create(long address)
```
    Returns a new VkDeviceGroupRenderPassBeginInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkDeviceGroupRenderPassBeginInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkDeviceGroupRenderPassBeginInfo.Buffer malloc(int capacity)
```
    Returns a new VkDeviceGroupRenderPassBeginInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkDeviceGroupRenderPassBeginInfo.Buffer calloc(int capacity)
```
    Returns a new VkDeviceGroupRenderPassBeginInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkDeviceGroupRenderPassBeginInfo.Buffer create(int capacity)
```
    Returns a new VkDeviceGroupRenderPassBeginInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkDeviceGroupRenderPassBeginInfo.Buffer create(long address,
                                                             int capacity)
```
    Create a VkDeviceGroupRenderPassBeginInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkDeviceGroupRenderPassBeginInfo.Buffer createSafe(long address,
                                                                           int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkDeviceGroupRenderPassBeginInfo mallocStack()
```
    Returns a new VkDeviceGroupRenderPassBeginInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkDeviceGroupRenderPassBeginInfo callocStack()
```
    Returns a new VkDeviceGroupRenderPassBeginInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkDeviceGroupRenderPassBeginInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDeviceGroupRenderPassBeginInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkDeviceGroupRenderPassBeginInfo callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDeviceGroupRenderPassBeginInfo instance allocated on the specified MemoryStack 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 new VkDeviceGroupRenderPassBeginInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDeviceGroupRenderPassBeginInfo.Buffer callocStack(int capacity)
```
    Returns a new VkDeviceGroupRenderPassBeginInfo.Buffer instance allocated on the thread-local MemoryStack 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 new VkDeviceGroupRenderPassBeginInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDeviceGroupRenderPassBeginInfo.Buffer callocStack(int capacity,
                                                                  org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDeviceGroupRenderPassBeginInfo.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().
  - ndeviceMask
```
public static int ndeviceMask(long struct)
```
    Unsafe version of deviceMask().
  - ndeviceRenderAreaCount
```
public static int ndeviceRenderAreaCount(long struct)
```
    Unsafe version of deviceRenderAreaCount().
  - npDeviceRenderAreas
```
@Nullable
public static VkRect2D.Buffer npDeviceRenderAreas(long struct)
```
    Unsafe version of pDeviceRenderAreas().
  - 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.
  - ndeviceMask
```
public static void ndeviceMask(long struct,
                               int value)
```
    Unsafe version of deviceMask.
  - ndeviceRenderAreaCount
```
public static void ndeviceRenderAreaCount(long struct,
                                          int value)
```
    Sets the specified value to the deviceRenderAreaCount field of the specified struct.
  - npDeviceRenderAreas
```
public static void npDeviceRenderAreas(long struct,
                                       @Nullable
                                       VkRect2D.Buffer value)
```
    Unsafe version of pDeviceRenderAreas.
  - validate
```
public static void validate(long struct)
```
    Validates pointer members that should not be NULL.
    
    Parameters:
    
    struct - the struct to validate
  - validate
```
public static void validate(long array,
                            int count)
```
    Calls validate(long) for each struct contained in the specified struct array.
    
    Parameters:
    
    array - the struct array to validate
    
    count - the number of structs in array

Class VkDeviceGroupRenderPassBeginInfo

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

DEVICEMASK

DEVICERENDERAREACOUNT

PDEVICERENDERAREAS

Constructor Detail

VkDeviceGroupRenderPassBeginInfo

Method Detail

sizeof

sType

pNext

deviceMask

deviceRenderAreaCount

pDeviceRenderAreas

sType

pNext

deviceMask

pDeviceRenderAreas

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

ndeviceMask

ndeviceRenderAreaCount

npDeviceRenderAreas

nsType

npNext

ndeviceMask

ndeviceRenderAreaCount

npDeviceRenderAreas

validate

validate