Package org.lwjgl.vulkan

Class VkDeviceGroupCommandBufferBeginInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDeviceGroupCommandBufferBeginInfo>

org.lwjgl.vulkan.VkDeviceGroupCommandBufferBeginInfo

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

Direct Known Subclasses:

VkDeviceGroupCommandBufferBeginInfoKHR

public class VkDeviceGroupCommandBufferBeginInfo
extends org.lwjgl.system.Struct<VkDeviceGroupCommandBufferBeginInfo>
implements org.lwjgl.system.NativeResource

Set the initial device mask for a command buffer.

Description

The initial device mask also acts as an upper bound on the set of devices that can ever be in the device mask in the command buffer.

If this structure is not present, the initial value of a command buffer’s device mask includes all physical devices in the logical device when the command buffer begins recording.

Valid Usage

• deviceMask must be a valid device mask value
• deviceMask must not be zero

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DEVICE_GROUP_COMMAND_BUFFER_BEGIN_INFO

Layout

 struct VkDeviceGroupCommandBufferBeginInfo {
     VkStructureType sType();
     void const * pNext();
     uint32_t deviceMask();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkDeviceGroupCommandBufferBeginInfo.Buffer	An array of VkDeviceGroupCommandBufferBeginInfo structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.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	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 org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkDeviceGroupCommandBufferBeginInfo	calloc()	Returns a new VkDeviceGroupCommandBufferBeginInfo instance allocated with memCalloc.
static VkDeviceGroupCommandBufferBeginInfo.Buffer	calloc(int capacity)	Returns a new VkDeviceGroupCommandBufferBeginInfo.Buffer instance allocated with memCalloc.
static VkDeviceGroupCommandBufferBeginInfo.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDeviceGroupCommandBufferBeginInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDeviceGroupCommandBufferBeginInfo	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDeviceGroupCommandBufferBeginInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDeviceGroupCommandBufferBeginInfo	callocStack()	Deprecated.
static VkDeviceGroupCommandBufferBeginInfo.Buffer	callocStack(int capacity)	Deprecated.
static VkDeviceGroupCommandBufferBeginInfo.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDeviceGroupCommandBufferBeginInfo	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDeviceGroupCommandBufferBeginInfo	create()	Returns a new VkDeviceGroupCommandBufferBeginInfo instance allocated with BufferUtils.
static VkDeviceGroupCommandBufferBeginInfo.Buffer	create(int capacity)	Returns a new VkDeviceGroupCommandBufferBeginInfo.Buffer instance allocated with BufferUtils.
static VkDeviceGroupCommandBufferBeginInfo	create(long address)	Returns a new VkDeviceGroupCommandBufferBeginInfo instance for the specified memory address.
static VkDeviceGroupCommandBufferBeginInfo.Buffer	create(long address, int capacity)	Create a VkDeviceGroupCommandBufferBeginInfo.Buffer instance at the specified memory.
static @Nullable VkDeviceGroupCommandBufferBeginInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDeviceGroupCommandBufferBeginInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	deviceMask()	the initial value of the command buffer’s device mask.
VkDeviceGroupCommandBufferBeginInfo	deviceMask(int value)	Sets the specified value to the deviceMask() field.
static VkDeviceGroupCommandBufferBeginInfo	malloc()	Returns a new VkDeviceGroupCommandBufferBeginInfo instance allocated with memAlloc.
static VkDeviceGroupCommandBufferBeginInfo.Buffer	malloc(int capacity)	Returns a new VkDeviceGroupCommandBufferBeginInfo.Buffer instance allocated with memAlloc.
static VkDeviceGroupCommandBufferBeginInfo.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDeviceGroupCommandBufferBeginInfo.Buffer instance allocated on the specified MemoryStack.
static VkDeviceGroupCommandBufferBeginInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDeviceGroupCommandBufferBeginInfo instance allocated on the specified MemoryStack.
static VkDeviceGroupCommandBufferBeginInfo	mallocStack()	Deprecated.
static VkDeviceGroupCommandBufferBeginInfo.Buffer	mallocStack(int capacity)	Deprecated.
static VkDeviceGroupCommandBufferBeginInfo.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDeviceGroupCommandBufferBeginInfo	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static int	ndeviceMask(long struct)	Unsafe version of deviceMask().
static void	ndeviceMask(long struct, int value)	Unsafe version of deviceMask.
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.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkDeviceGroupCommandBufferBeginInfo	pNext(long value)	Sets the specified value to the pNext() field.
VkDeviceGroupCommandBufferBeginInfo	set(int sType, long pNext, int deviceMask)	Initializes this struct with the specified values.
VkDeviceGroupCommandBufferBeginInfo	set(VkDeviceGroupCommandBufferBeginInfo src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkDeviceGroupCommandBufferBeginInfo	sType(int value)	Sets the specified value to the sType() field.
VkDeviceGroupCommandBufferBeginInfo	sType$Default()	Sets the STRUCTURE_TYPE_DEVICE_GROUP_COMMAND_BUFFER_BEGIN_INFO value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

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 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.

Constructor Details

VkDeviceGroupCommandBufferBeginInfo

public VkDeviceGroupCommandBufferBeginInfo(ByteBuffer container)

Creates a VkDeviceGroupCommandBufferBeginInfo 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()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkDeviceGroupCommandBufferBeginInfo>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

deviceMask

public int deviceMask()

the initial value of the command buffer’s device mask.

sType

public VkDeviceGroupCommandBufferBeginInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkDeviceGroupCommandBufferBeginInfo sType$Default()

Sets the STRUCTURE_TYPE_DEVICE_GROUP_COMMAND_BUFFER_BEGIN_INFO value to the sType() field.

pNext

public VkDeviceGroupCommandBufferBeginInfo pNext(long value)

Sets the specified value to the pNext() field.

deviceMask

public VkDeviceGroupCommandBufferBeginInfo deviceMask(int value)

Sets the specified value to the deviceMask() field.

set

public VkDeviceGroupCommandBufferBeginInfo set(int sType,
 long pNext,
 int deviceMask)

Initializes this struct with the specified values.

set

public VkDeviceGroupCommandBufferBeginInfo set(VkDeviceGroupCommandBufferBeginInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDeviceGroupCommandBufferBeginInfo malloc()

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

calloc

public static VkDeviceGroupCommandBufferBeginInfo calloc()

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

create

public static VkDeviceGroupCommandBufferBeginInfo create()

Returns a new VkDeviceGroupCommandBufferBeginInfo instance allocated with BufferUtils.

create

public static VkDeviceGroupCommandBufferBeginInfo create(long address)

Returns a new VkDeviceGroupCommandBufferBeginInfo instance for the specified memory address.

createSafe

public static @Nullable VkDeviceGroupCommandBufferBeginInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDeviceGroupCommandBufferBeginInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDeviceGroupCommandBufferBeginInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDeviceGroupCommandBufferBeginInfo.Buffer create(int capacity)

Returns a new VkDeviceGroupCommandBufferBeginInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDeviceGroupCommandBufferBeginInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkDeviceGroupCommandBufferBeginInfo mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkDeviceGroupCommandBufferBeginInfo callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkDeviceGroupCommandBufferBeginInfo mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkDeviceGroupCommandBufferBeginInfo callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static VkDeviceGroupCommandBufferBeginInfo.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static VkDeviceGroupCommandBufferBeginInfo.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static VkDeviceGroupCommandBufferBeginInfo.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkDeviceGroupCommandBufferBeginInfo.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

malloc

public static VkDeviceGroupCommandBufferBeginInfo malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkDeviceGroupCommandBufferBeginInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkDeviceGroupCommandBufferBeginInfo calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkDeviceGroupCommandBufferBeginInfo.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkDeviceGroupCommandBufferBeginInfo.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkDeviceGroupCommandBufferBeginInfo.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().

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.