Class VkDeviceGroupRenderPassBeginInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDeviceGroupRenderPassBeginInfo>

org.lwjgl.vulkan.VkDeviceGroupRenderPassBeginInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkDeviceGroupRenderPassBeginInfoKHR

public class VkDeviceGroupRenderPassBeginInfo
extends Struct<VkDeviceGroupRenderPassBeginInfo>
implements NativeResource

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 of VkDeviceGroupRenderPassBeginInfo structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	DEVICEMASK	The struct member offsets.
static final int	DEVICERENDERAREACOUNT	The struct member offsets.
static final int	PDEVICERENDERAREAS	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkDeviceGroupRenderPassBeginInfo(ByteBuffer container)	Creates a VkDeviceGroupRenderPassBeginInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	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.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkDeviceGroupRenderPassBeginInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDeviceGroupRenderPassBeginInfo	calloc(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 @Nullable VkDeviceGroupRenderPassBeginInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDeviceGroupRenderPassBeginInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	deviceMask()
VkDeviceGroupRenderPassBeginInfo	deviceMask(int value)	Sets the specified value to the deviceMask field.
int	deviceRenderAreaCount()
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.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkDeviceGroupRenderPassBeginInfo.Buffer instance allocated on the specified MemoryStack.
static VkDeviceGroupRenderPassBeginInfo	malloc(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 @Nullable VkRect2D.Buffer	npDeviceRenderAreas(long struct)	Unsafe version of pDeviceRenderAreas().
static void	npDeviceRenderAreas(long struct, @Nullable 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.
@Nullable VkRect2D.Buffer	pDeviceRenderAreas()
VkDeviceGroupRenderPassBeginInfo	pDeviceRenderAreas(@Nullable VkRect2D.Buffer value)	Sets the address of the specified VkRect2D.Buffer to the pDeviceRenderAreas field.
long	pNext()
VkDeviceGroupRenderPassBeginInfo	pNext(long value)	Sets the specified value to the pNext field.
VkDeviceGroupRenderPassBeginInfo	set(int sType, long pNext, int deviceMask, @Nullable VkRect2D.Buffer pDeviceRenderAreas)	Initializes this struct with the specified values.
VkDeviceGroupRenderPassBeginInfo	set(VkDeviceGroupRenderPassBeginInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()
VkDeviceGroupRenderPassBeginInfo	sType(int value)	Sets the specified value to the sType field.
VkDeviceGroupRenderPassBeginInfo	sType$Default()	Sets the STRUCTURE_TYPE_DEVICE_GROUP_RENDER_PASS_BEGIN_INFO value to the sType field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface NativeResource

close, free

Field Details

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 Details

VkDeviceGroupRenderPassBeginInfo

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkDeviceGroupRenderPassBeginInfo>

sType

@NativeType("VkStructureType")
public int sType()

Returns:

the value of the sType field.

pNext

@NativeType("void const *")
public long pNext()

Returns:

the value of the pNext field.

deviceMask

@NativeType("uint32_t")
public int deviceMask()

Returns:

the value of the deviceMask field.

deviceRenderAreaCount

@NativeType("uint32_t")
public int deviceRenderAreaCount()

Returns:

the value of the deviceRenderAreaCount field.

pDeviceRenderAreas

@NativeType("VkRect2D const *")
public @Nullable VkRect2D.Buffer pDeviceRenderAreas()

Returns:

a VkRect2D.Buffer view of the struct array pointed to by the pDeviceRenderAreas field.

sType

public VkDeviceGroupRenderPassBeginInfo sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

sType$Default

public VkDeviceGroupRenderPassBeginInfo sType$Default()

Sets the STRUCTURE_TYPE_DEVICE_GROUP_RENDER_PASS_BEGIN_INFO value to the sType field.

pNext

public VkDeviceGroupRenderPassBeginInfo pNext(@NativeType("void const *")
 long value)

Sets the specified value to the pNext field.

deviceMask

public VkDeviceGroupRenderPassBeginInfo deviceMask(@NativeType("uint32_t")
 int value)

Sets the specified value to the deviceMask field.

pDeviceRenderAreas

public VkDeviceGroupRenderPassBeginInfo pDeviceRenderAreas(@NativeType("VkRect2D const *")
 @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

public static @Nullable 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

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

Like create, but returns null if address is NULL.

malloc

public static VkDeviceGroupRenderPassBeginInfo malloc(MemoryStack stack)

Returns a new VkDeviceGroupRenderPassBeginInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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 - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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 - the buffer capacity

stack - the stack from which to allocate

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

public static @Nullable 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