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 a render pass instance and commands ending the render pass instance, and, accordingly render pass load, store, and multisample 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
The offset.x member of any element of pDeviceRenderAreas must be greater than or equal to 0
The offset.y member of any element of pDeviceRenderAreas must be greater than or equal to 0
The sum of the offset.x and extent.width members of any element of pDeviceRenderAreas must be less than or equal to maxFramebufferWidth
The sum of the offset.y and extent.height members of any element of pDeviceRenderAreas must be less than or equal to maxFramebufferHeight
The extent.width member of any element of pDeviceRenderAreas must be greater than 0
The extent.height member of any element of pDeviceRenderAreas must be greater than 0

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

Layout


struct VkDeviceGroupRenderPassBeginInfo {
    VkStructureType sType;
    void const * pNext;
    uint32_t deviceMask;
    uint32_t deviceRenderAreaCount;
    VkRect2D const * pDeviceRenderAreas;
}

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	VkDeviceGroupRenderPassBeginInfo.Buffer An array of `VkDeviceGroupRenderPassBeginInfo` structs.

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	DEVICEMASK The struct member offsets.
public static final int	DEVICERENDERAREACOUNT The struct member offsets.
public static final int	PDEVICERENDERAREAS 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:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	VkDeviceGroupRenderPassBeginInfo(long address, ByteBuffer container)
public	VkDeviceGroupRenderPassBeginInfo(ByteBuffer container) Creates a `VkDeviceGroupRenderPassBeginInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static VkDeviceGroupRenderPassBeginInfo	calloc() Returns a new `VkDeviceGroupRenderPassBeginInfo` instance allocated with `memCalloc`.
public static VkDeviceGroupRenderPassBeginInfo.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkDeviceGroupRenderPassBeginInfo.Buffer` instance allocated with `memCalloc`.
public static VkDeviceGroupRenderPassBeginInfo	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkDeviceGroupRenderPassBeginInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkDeviceGroupRenderPassBeginInfo.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkDeviceGroupRenderPassBeginInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkDeviceGroupRenderPassBeginInfo	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkDeviceGroupRenderPassBeginInfo	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkDeviceGroupRenderPassBeginInfo.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkDeviceGroupRenderPassBeginInfo.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkDeviceGroupRenderPassBeginInfo	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 VkDeviceGroupRenderPassBeginInfo	create() Returns a new `VkDeviceGroupRenderPassBeginInfo` instance allocated with `BufferUtils`.
public static VkDeviceGroupRenderPassBeginInfo	create(long address) Returns a new `VkDeviceGroupRenderPassBeginInfo` instance for the specified memory address.
public static VkDeviceGroupRenderPassBeginInfo.Buffer	create(int the buffer capacity capacity) Returns a new `VkDeviceGroupRenderPassBeginInfo.Buffer` instance allocated with `BufferUtils`.
public static VkDeviceGroupRenderPassBeginInfo.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkDeviceGroupRenderPassBeginInfo.Buffer` instance at the specified memory.
public static VkDeviceGroupRenderPassBeginInfo	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkDeviceGroupRenderPassBeginInfo.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	deviceMask() the device mask for the render pass instance.
public VkDeviceGroupRenderPassBeginInfo	deviceMask(int value) Sets the specified value to the `deviceMask` field.
public int	deviceRenderAreaCount() the number of elements in the `pDeviceRenderAreas` array.
public static VkDeviceGroupRenderPassBeginInfo	malloc() Returns a new `VkDeviceGroupRenderPassBeginInfo` instance allocated with `memAlloc`.
public static VkDeviceGroupRenderPassBeginInfo.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkDeviceGroupRenderPassBeginInfo.Buffer` instance allocated with `memAlloc`.
public static VkDeviceGroupRenderPassBeginInfo	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkDeviceGroupRenderPassBeginInfo` instance allocated on the specified `MemoryStack`.
public static VkDeviceGroupRenderPassBeginInfo.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkDeviceGroupRenderPassBeginInfo.Buffer` instance allocated on the specified `MemoryStack`.
public static VkDeviceGroupRenderPassBeginInfo	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkDeviceGroupRenderPassBeginInfo	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkDeviceGroupRenderPassBeginInfo.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkDeviceGroupRenderPassBeginInfo.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static int	ndeviceMask(long struct) Unsafe version of `deviceMask`.
public static void	ndeviceMask(long struct, int value) Unsafe version of `deviceMask`.
public static int	ndeviceRenderAreaCount(long struct) Unsafe version of `deviceRenderAreaCount`.
public static void	ndeviceRenderAreaCount(long struct, int value) Sets the specified value to the `deviceRenderAreaCount` field of the specified `struct`.
public static VkRect2D.Buffer	npDeviceRenderAreas(long struct) Unsafe version of `pDeviceRenderAreas`.
public static void	npDeviceRenderAreas(long struct, VkRect2D.Buffer value) Unsafe version of `pDeviceRenderAreas`.
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 VkRect2D.Buffer	pDeviceRenderAreas() a pointer to an array of `VkRect2D` structures defining the render area for each physical device.
public VkDeviceGroupRenderPassBeginInfo	pDeviceRenderAreas(VkRect2D.Buffer value) Sets the address of the specified `VkRect2D.Buffer` to the `pDeviceRenderAreas` field.
public long	pNext() `NULL` or a pointer to a structure extending this structure.
public VkDeviceGroupRenderPassBeginInfo	pNext(long value) Sets the specified value to the `pNext` field.
public VkDeviceGroupRenderPassBeginInfo	set(int sType, long pNext, int deviceMask, VkRect2D.Buffer pDeviceRenderAreas) Initializes this struct with the specified values.
public VkDeviceGroupRenderPassBeginInfo	Returns: this struct set(VkDeviceGroupRenderPassBeginInfo 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 VkDeviceGroupRenderPassBeginInfo	sType(int value) Sets the specified value to the `sType` field.
public VkDeviceGroupRenderPassBeginInfo	sType$Default() Sets the `STRUCTURE_TYPE_DEVICE_GROUP_RENDER_PASS_BEGIN_INFO` value to the `sType` field.
public static void	validate(long the struct to validate struct) Validates pointer members that should not be `NULL`.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

DEVICEMASK	back to summary
public static final int DEVICEMASK The struct member offsets.

DEVICERENDERAREACOUNT	back to summary
public static final int DEVICERENDERAREACOUNT The struct member offsets.

PDEVICERENDERAREAS	back to summary
public static final int PDEVICERENDERAREAS The struct member offsets.

PNEXT	back to summary
public static final int PNEXT The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

STYPE	back to summary
public static final int STYPE The struct member offsets.

Constructor Detail

VkDeviceGroupRenderPassBeginInfo	back to summary
protected VkDeviceGroupRenderPassBeginInfo(long address, ByteBuffer container)

VkDeviceGroupRenderPassBeginInfo back to summary

VkDeviceGroupRenderPassBeginInfo	back to summary
public VkDeviceGroupRenderPassBeginInfo(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.

public VkDeviceGroupRenderPassBeginInfo(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

calloc	back to summary
public static VkDeviceGroupRenderPassBeginInfo calloc() Returns a new `VkDeviceGroupRenderPassBeginInfo` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static VkDeviceGroupRenderPassBeginInfo.Buffer calloc(int capacity) Returns a new `VkDeviceGroupRenderPassBeginInfo.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkDeviceGroupRenderPassBeginInfo.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static VkDeviceGroupRenderPassBeginInfo calloc(MemoryStack stack) Returns a new `VkDeviceGroupRenderPassBeginInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkDeviceGroupRenderPassBeginInfo calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static VkDeviceGroupRenderPassBeginInfo.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkDeviceGroupRenderPassBeginInfo.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

public static VkDeviceGroupRenderPassBeginInfo.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkDeviceGroupRenderPassBeginInfo.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

callocStack back to summary

callocStack	back to summary
public static VkDeviceGroupRenderPassBeginInfo callocStack() Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkDeviceGroupRenderPassBeginInfo callocStack()

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkDeviceGroupRenderPassBeginInfo callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkDeviceGroupRenderPassBeginInfo callocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkDeviceGroupRenderPassBeginInfo.Buffer callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkDeviceGroupRenderPassBeginInfo.Buffer callocStack(int capacity)

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkDeviceGroupRenderPassBeginInfo.Buffer callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkDeviceGroupRenderPassBeginInfo.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

create back to summary

create	back to summary
protected VkDeviceGroupRenderPassBeginInfo 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

protected VkDeviceGroupRenderPassBeginInfo 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

create	back to summary
public static VkDeviceGroupRenderPassBeginInfo create() Returns a new `VkDeviceGroupRenderPassBeginInfo` instance allocated with `BufferUtils`.

create	back to summary
public static VkDeviceGroupRenderPassBeginInfo create(long address) Returns a new `VkDeviceGroupRenderPassBeginInfo` instance for the specified memory address.

create back to summary

create	back to summary
public static VkDeviceGroupRenderPassBeginInfo.Buffer create(int capacity) Returns a new `VkDeviceGroupRenderPassBeginInfo.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static VkDeviceGroupRenderPassBeginInfo.Buffer create(int capacity)

Returns a new VkDeviceGroupRenderPassBeginInfo.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static VkDeviceGroupRenderPassBeginInfo.Buffer create(long address, int capacity) Create a `VkDeviceGroupRenderPassBeginInfo.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

public static VkDeviceGroupRenderPassBeginInfo.Buffer create(long address, int capacity)

Create a VkDeviceGroupRenderPassBeginInfo.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static VkDeviceGroupRenderPassBeginInfo createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkDeviceGroupRenderPassBeginInfo createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static VkDeviceGroupRenderPassBeginInfo.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

deviceMask	back to summary
public int deviceMask() the device mask for the render pass instance. Annotations @NativeType:uint32_t

deviceMask

back to summary

public int deviceMask()

the device mask for the render pass instance.

Annotations

@NativeType:uint32_t

deviceMask	back to summary
public VkDeviceGroupRenderPassBeginInfo deviceMask(int value) Sets the specified value to the `deviceMask` field.

deviceRenderAreaCount back to summary

deviceRenderAreaCount	back to summary
public int deviceRenderAreaCount() the number of elements in the `pDeviceRenderAreas` array. Annotations @NativeType:uint32_t

public int deviceRenderAreaCount()

the number of elements in the pDeviceRenderAreas array.

Annotations

@NativeType:uint32_t

malloc	back to summary
public static VkDeviceGroupRenderPassBeginInfo malloc() Returns a new `VkDeviceGroupRenderPassBeginInfo` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static VkDeviceGroupRenderPassBeginInfo.Buffer malloc(int capacity) Returns a new `VkDeviceGroupRenderPassBeginInfo.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkDeviceGroupRenderPassBeginInfo.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static VkDeviceGroupRenderPassBeginInfo malloc(MemoryStack stack) Returns a new `VkDeviceGroupRenderPassBeginInfo` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkDeviceGroupRenderPassBeginInfo malloc(MemoryStack stack)

Returns a new VkDeviceGroupRenderPassBeginInfo instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static VkDeviceGroupRenderPassBeginInfo.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkDeviceGroupRenderPassBeginInfo.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static VkDeviceGroupRenderPassBeginInfo.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

mallocStack back to summary

mallocStack	back to summary
public static VkDeviceGroupRenderPassBeginInfo mallocStack() Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkDeviceGroupRenderPassBeginInfo mallocStack()

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkDeviceGroupRenderPassBeginInfo mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkDeviceGroupRenderPassBeginInfo mallocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkDeviceGroupRenderPassBeginInfo.Buffer mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkDeviceGroupRenderPassBeginInfo.Buffer mallocStack(int capacity)

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkDeviceGroupRenderPassBeginInfo.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkDeviceGroupRenderPassBeginInfo.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

ndeviceMask	back to summary
public static int ndeviceMask(long struct) Unsafe version of `deviceMask`.

ndeviceMask	back to summary
public static void ndeviceMask(long struct, int value) Unsafe version of `deviceMask`.

ndeviceRenderAreaCount	back to summary
public static int ndeviceRenderAreaCount(long struct) Unsafe version of `deviceRenderAreaCount`.

ndeviceRenderAreaCount	back to summary
public static void ndeviceRenderAreaCount(long struct, int value) Sets the specified value to the `deviceRenderAreaCount` field of the specified `struct`.

npDeviceRenderAreas back to summary

npDeviceRenderAreas	back to summary
public static VkRect2D.Buffer npDeviceRenderAreas(long struct) Unsafe version of `pDeviceRenderAreas`. Annotations @Nullable

public static VkRect2D.Buffer npDeviceRenderAreas(long struct)

Unsafe version of pDeviceRenderAreas.

Annotations

@Nullable

npDeviceRenderAreas	back to summary
public static void npDeviceRenderAreas(long struct, VkRect2D.Buffer value) Unsafe version of `pDeviceRenderAreas`.

npNext	back to summary
public static long npNext(long struct) Unsafe version of `pNext`.

npNext	back to summary
public static void npNext(long struct, long value) Unsafe version of `pNext`.

nsType	back to summary
public static int nsType(long struct) Unsafe version of `sType`.

nsType	back to summary
public static void nsType(long struct, int value) Unsafe version of `sType`.

pDeviceRenderAreas back to summary

pDeviceRenderAreas	back to summary
public VkRect2D.Buffer pDeviceRenderAreas() a pointer to an array of `VkRect2D` structures defining the render area for each physical device. Annotations @Nullable @NativeType:VkRect2D const *

public VkRect2D.Buffer pDeviceRenderAreas()

a pointer to an array of VkRect2D structures defining the render area for each physical device.

Annotations

@Nullable
@NativeType:VkRect2D const *

pDeviceRenderAreas	back to summary
public VkDeviceGroupRenderPassBeginInfo pDeviceRenderAreas(VkRect2D.Buffer value) Sets the address of the specified `VkRect2D.Buffer` to the `pDeviceRenderAreas` field.

pNext back to summary

public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations

@NativeType:void const *

pNext	back to summary
public VkDeviceGroupRenderPassBeginInfo pNext(long value) Sets the specified value to the `pNext` field.

set	back to summary
public VkDeviceGroupRenderPassBeginInfo set(int sType, long pNext, int deviceMask, VkRect2D.Buffer pDeviceRenderAreas) Initializes this struct with the specified values.

set

back to summary

public VkDeviceGroupRenderPassBeginInfo set(VkDeviceGroupRenderPassBeginInfo src)

Copies the specified struct data to this struct.

Parameters

src:VkDeviceGroupRenderPassBeginInfo: the source struct

Returns:VkDeviceGroupRenderPassBeginInfo

this struct

sizeof back to summary

public int sizeof()

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

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

Returns sizeof(struct).

Annotations

@Override

sType back to summary

public int sType()

a VkStructureType value identifying this structure.

Annotations

@NativeType:VkStructureType

sType	back to summary
public VkDeviceGroupRenderPassBeginInfo sType(int value) Sets the specified value to the `sType` field.

sType$Default	back to summary
public VkDeviceGroupRenderPassBeginInfo sType$Default() Sets the `STRUCTURE_TYPE_DEVICE_GROUP_RENDER_PASS_BEGIN_INFO` value to the `sType` field.

validate back to summary

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters

struct:long: the struct to validate

org.lwjgl.vulkan back to summary

public Class VkDeviceGroupRenderPassBeginInfo.Buffer

Class Inheritance

extends StructBuffer<VkDeviceGroupRenderPassBeginInfo, VkDeviceGroupRenderPassBeginInfo.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.vulkan.VkDeviceGroupRenderPassBeginInfo.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

Known Direct Subclasses

org.lwjgl.vulkan.VkDeviceGroupRenderPassBeginInfoKHR.Buffer

An array of VkDeviceGroupRenderPassBeginInfo structs.

Field Summary

Modifier and Type	Field and Description
private static final VkDeviceGroupRenderPassBeginInfo	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkDeviceGroupRenderPassBeginInfo.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 Type	Method and Description
public int	Returns: the value of the `VkDeviceGroupRenderPassBeginInfo#deviceMask` field. deviceMask()
public VkDeviceGroupRenderPassBeginInfo.Buffer	deviceMask(int value) Sets the specified value to the `VkDeviceGroupRenderPassBeginInfo#deviceMask` field.
public int	Returns: the value of the `VkDeviceGroupRenderPassBeginInfo#deviceRenderAreaCount` field. deviceRenderAreaCount()
protected VkDeviceGroupRenderPassBeginInfo	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public VkRect2D.Buffer	Returns: a `VkRect2D.Buffer` view of the struct array pointed to by the `VkDeviceGroupRenderPassBeginInfo#pDeviceRenderAreas` field. pDeviceRenderAreas()
public VkDeviceGroupRenderPassBeginInfo.Buffer	pDeviceRenderAreas(VkRect2D.Buffer value) Sets the address of the specified `VkRect2D.Buffer` to the `VkDeviceGroupRenderPassBeginInfo#pDeviceRenderAreas` field.
public long	Returns: the value of the `VkDeviceGroupRenderPassBeginInfo#pNext` field. pNext()
public VkDeviceGroupRenderPassBeginInfo.Buffer	pNext(long value) Sets the specified value to the `VkDeviceGroupRenderPassBeginInfo#pNext` field.
protected VkDeviceGroupRenderPassBeginInfo.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `VkDeviceGroupRenderPassBeginInfo#sType` field. sType()
public VkDeviceGroupRenderPassBeginInfo.Buffer	sType(int value) Sets the specified value to the `VkDeviceGroupRenderPassBeginInfo#sType` field.
public VkDeviceGroupRenderPassBeginInfo.Buffer	sType$Default() Sets the `STRUCTURE_TYPE_DEVICE_GROUP_RENDER_PASS_BEGIN_INFO` value to the `VkDeviceGroupRenderPassBeginInfo#sType` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final VkDeviceGroupRenderPassBeginInfo ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new VkDeviceGroupRenderPassBeginInfo.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 VkDeviceGroupRenderPassBeginInfo#SIZEOF, and its mark will be undefined.

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

Buffer	back to summary
public Buffer(long address, int cap)

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

Method Detail

deviceMask	back to summary
public int deviceMask() Returns:int the value of the `VkDeviceGroupRenderPassBeginInfo#deviceMask` field. Annotations @NativeType:uint32_t

deviceMask	back to summary
public VkDeviceGroupRenderPassBeginInfo.Buffer deviceMask(int value) Sets the specified value to the `VkDeviceGroupRenderPassBeginInfo#deviceMask` field.

deviceRenderAreaCount	back to summary
public int deviceRenderAreaCount() Returns:int the value of the `VkDeviceGroupRenderPassBeginInfo#deviceRenderAreaCount` field. Annotations @NativeType:uint32_t

getElementFactory

back to summary

protected VkDeviceGroupRenderPassBeginInfo getElementFactory()

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

Annotations

@Override

pDeviceRenderAreas	back to summary
public VkRect2D.Buffer pDeviceRenderAreas() Returns:VkRect2D.Buffer a `VkRect2D.Buffer` view of the struct array pointed to by the `VkDeviceGroupRenderPassBeginInfo#pDeviceRenderAreas` field. Annotations @Nullable @NativeType:VkRect2D const *

pDeviceRenderAreas	back to summary
public VkDeviceGroupRenderPassBeginInfo.Buffer pDeviceRenderAreas(VkRect2D.Buffer value) Sets the address of the specified `VkRect2D.Buffer` to the `VkDeviceGroupRenderPassBeginInfo#pDeviceRenderAreas` field.

pNext	back to summary
public long pNext() Returns:long the value of the `VkDeviceGroupRenderPassBeginInfo#pNext` field. Annotations @NativeType:void const *

pNext	back to summary
public VkDeviceGroupRenderPassBeginInfo.Buffer pNext(long value) Sets the specified value to the `VkDeviceGroupRenderPassBeginInfo#pNext` field.

self

back to summary

protected VkDeviceGroupRenderPassBeginInfo.Buffer self()

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

Annotations

@Override

sType	back to summary
public int sType() Returns:int the value of the `VkDeviceGroupRenderPassBeginInfo#sType` field. Annotations @NativeType:VkStructureType

sType	back to summary
public VkDeviceGroupRenderPassBeginInfo.Buffer sType(int value) Sets the specified value to the `VkDeviceGroupRenderPassBeginInfo#sType` field.

sType$Default	back to summary
public VkDeviceGroupRenderPassBeginInfo.Buffer sType$Default() Sets the `STRUCTURE_TYPE_DEVICE_GROUP_RENDER_PASS_BEGIN_INFO` value to the `VkDeviceGroupRenderPassBeginInfo#sType` field.

public Class VkDeviceGroupRenderPassBeginInfo

Description

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class VkDeviceGroupRenderPassBeginInfo.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail