Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkDeviceGroupCommandBufferBeginInfo

extends Struct<VkDeviceGroupCommandBufferBeginInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkDeviceGroupCommandBufferBeginInfoKHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
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 is set to include all physical devices in the logical device when the command buffer begins recording.

Valid Usage
Valid Usage (Implicit)

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkDeviceGroupCommandBufferBeginInfo.Buffer

An array of VkDeviceGroupCommandBufferBeginInfo structs.

Field Summary

Modifier and TypeField 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
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:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkDeviceGroupCommandBufferBeginInfo(long address, ByteBuffer container)

public
VkDeviceGroupCommandBufferBeginInfo(ByteBuffer container)

Creates a VkDeviceGroupCommandBufferBeginInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkDeviceGroupCommandBufferBeginInfo
calloc()

Returns a new VkDeviceGroupCommandBufferBeginInfo instance allocated with memCalloc.

public static VkDeviceGroupCommandBufferBeginInfo.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new VkDeviceGroupCommandBufferBeginInfo.Buffer instance allocated with memCalloc.

public static VkDeviceGroupCommandBufferBeginInfo
calloc(MemoryStack
the stack from which to allocate
stack)

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

public static VkDeviceGroupCommandBufferBeginInfo.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static VkDeviceGroupCommandBufferBeginInfo
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkDeviceGroupCommandBufferBeginInfo
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDeviceGroupCommandBufferBeginInfo.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDeviceGroupCommandBufferBeginInfo.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkDeviceGroupCommandBufferBeginInfo
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 VkDeviceGroupCommandBufferBeginInfo
create()

Returns a new VkDeviceGroupCommandBufferBeginInfo instance allocated with BufferUtils.

public static VkDeviceGroupCommandBufferBeginInfo
create(long address)

Returns a new VkDeviceGroupCommandBufferBeginInfo instance for the specified memory address.

public static VkDeviceGroupCommandBufferBeginInfo.Buffer
create(int
the buffer capacity
capacity)

Returns a new VkDeviceGroupCommandBufferBeginInfo.Buffer instance allocated with BufferUtils.

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

Create a VkDeviceGroupCommandBufferBeginInfo.Buffer instance at the specified memory.

public static VkDeviceGroupCommandBufferBeginInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
deviceMask()

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

public VkDeviceGroupCommandBufferBeginInfo
deviceMask(int value)

Sets the specified value to the deviceMask field.

public static VkDeviceGroupCommandBufferBeginInfo
malloc()

Returns a new VkDeviceGroupCommandBufferBeginInfo instance allocated with memAlloc.

public static VkDeviceGroupCommandBufferBeginInfo.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new VkDeviceGroupCommandBufferBeginInfo.Buffer instance allocated with memAlloc.

public static VkDeviceGroupCommandBufferBeginInfo
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkDeviceGroupCommandBufferBeginInfo instance allocated on the specified MemoryStack.

public static VkDeviceGroupCommandBufferBeginInfo.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static VkDeviceGroupCommandBufferBeginInfo
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkDeviceGroupCommandBufferBeginInfo
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDeviceGroupCommandBufferBeginInfo.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDeviceGroupCommandBufferBeginInfo.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 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 long
pNext()

NULL or a pointer to a structure extending this structure.

public VkDeviceGroupCommandBufferBeginInfo
pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkDeviceGroupCommandBufferBeginInfo

Returns:

this struct
set(VkDeviceGroupCommandBufferBeginInfo
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 VkDeviceGroupCommandBufferBeginInfo
sType(int value)

Sets the specified value to the sType field.

public VkDeviceGroupCommandBufferBeginInfo
sType$Default()

Sets the STRUCTURE_TYPE_DEVICE_GROUP_COMMAND_BUFFER_BEGIN_INFO value to the sType field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

DEVICEMASKback to summary
public static final int DEVICEMASK

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkDeviceGroupCommandBufferBeginInfoback to summary
protected VkDeviceGroupCommandBufferBeginInfo(long address, ByteBuffer container)
VkDeviceGroupCommandBufferBeginInfoback to summary
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 Detail

callocback to summary
public static VkDeviceGroupCommandBufferBeginInfo calloc()

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

callocback to summary
public static VkDeviceGroupCommandBufferBeginInfo.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkDeviceGroupCommandBufferBeginInfo calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkDeviceGroupCommandBufferBeginInfo.Buffer calloc(int capacity, MemoryStack stack)

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

callocStackback to summary
public static VkDeviceGroupCommandBufferBeginInfo callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkDeviceGroupCommandBufferBeginInfo callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkDeviceGroupCommandBufferBeginInfo.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkDeviceGroupCommandBufferBeginInfo.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected VkDeviceGroupCommandBufferBeginInfo 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
createback to summary
public static VkDeviceGroupCommandBufferBeginInfo create()

Returns a new VkDeviceGroupCommandBufferBeginInfo instance allocated with BufferUtils.

createback to summary
public static VkDeviceGroupCommandBufferBeginInfo create(long address)

Returns a new VkDeviceGroupCommandBufferBeginInfo instance for the specified memory address.

createback to summary
public static VkDeviceGroupCommandBufferBeginInfo.Buffer create(int capacity)

Returns a new VkDeviceGroupCommandBufferBeginInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkDeviceGroupCommandBufferBeginInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkDeviceGroupCommandBufferBeginInfo createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkDeviceGroupCommandBufferBeginInfo.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
deviceMaskback to summary
public int deviceMask()

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

Annotations
@NativeType:uint32_t
deviceMaskback to summary
public VkDeviceGroupCommandBufferBeginInfo deviceMask(int value)

Sets the specified value to the deviceMask field.

mallocback to summary
public static VkDeviceGroupCommandBufferBeginInfo malloc()

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

mallocback to summary
public static VkDeviceGroupCommandBufferBeginInfo.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkDeviceGroupCommandBufferBeginInfo malloc(MemoryStack stack)

Returns a new VkDeviceGroupCommandBufferBeginInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkDeviceGroupCommandBufferBeginInfo.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkDeviceGroupCommandBufferBeginInfo mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkDeviceGroupCommandBufferBeginInfo mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkDeviceGroupCommandBufferBeginInfo.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkDeviceGroupCommandBufferBeginInfo.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
ndeviceMaskback to summary
public static int ndeviceMask(long struct)

Unsafe version of deviceMask.

ndeviceMaskback to summary
public static void ndeviceMask(long struct, int value)

Unsafe version of deviceMask.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkDeviceGroupCommandBufferBeginInfo pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkDeviceGroupCommandBufferBeginInfo set(int sType, long pNext, int deviceMask)

Initializes this struct with the specified values.

setback to summary
public VkDeviceGroupCommandBufferBeginInfo set(VkDeviceGroupCommandBufferBeginInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkDeviceGroupCommandBufferBeginInfo

the source struct

Returns:VkDeviceGroupCommandBufferBeginInfo

this struct

sizeofback to summary
public int sizeof()

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

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

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkDeviceGroupCommandBufferBeginInfo sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkDeviceGroupCommandBufferBeginInfo sType$Default()

Sets the STRUCTURE_TYPE_DEVICE_GROUP_COMMAND_BUFFER_BEGIN_INFO value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkDeviceGroupCommandBufferBeginInfo.Buffer

extends StructBuffer<VkDeviceGroupCommandBufferBeginInfo, VkDeviceGroupCommandBufferBeginInfo.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkDeviceGroupCommandBufferBeginInfoKHR.Buffer
An array of VkDeviceGroupCommandBufferBeginInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VkDeviceGroupCommandBufferBeginInfo
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkDeviceGroupCommandBufferBeginInfo.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 TypeMethod and Description
public int

Returns:

the value of the VkDeviceGroupCommandBufferBeginInfo#deviceMask field.
deviceMask()

public VkDeviceGroupCommandBufferBeginInfo.Buffer
deviceMask(int value)

Sets the specified value to the VkDeviceGroupCommandBufferBeginInfo#deviceMask field.

protected VkDeviceGroupCommandBufferBeginInfo
getElementFactory()

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

public long

Returns:

the value of the VkDeviceGroupCommandBufferBeginInfo#pNext field.
pNext()

public VkDeviceGroupCommandBufferBeginInfo.Buffer
pNext(long value)

Sets the specified value to the VkDeviceGroupCommandBufferBeginInfo#pNext field.

protected VkDeviceGroupCommandBufferBeginInfo.Buffer
self()

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

public int

Returns:

the value of the VkDeviceGroupCommandBufferBeginInfo#sType field.
sType()

public VkDeviceGroupCommandBufferBeginInfo.Buffer
sType(int value)

Sets the specified value to the VkDeviceGroupCommandBufferBeginInfo#sType field.

public VkDeviceGroupCommandBufferBeginInfo.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_DEVICE_GROUP_COMMAND_BUFFER_BEGIN_INFO value to the VkDeviceGroupCommandBufferBeginInfo#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkDeviceGroupCommandBufferBeginInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

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

Method Detail

deviceMaskback to summary
public int deviceMask()
Returns:int

the value of the VkDeviceGroupCommandBufferBeginInfo#deviceMask field.

Annotations
@NativeType:uint32_t
deviceMaskback to summary
public VkDeviceGroupCommandBufferBeginInfo.Buffer deviceMask(int value)

Sets the specified value to the VkDeviceGroupCommandBufferBeginInfo#deviceMask field.

getElementFactoryback to summary
protected VkDeviceGroupCommandBufferBeginInfo getElementFactory()

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

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkDeviceGroupCommandBufferBeginInfo#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkDeviceGroupCommandBufferBeginInfo.Buffer pNext(long value)

Sets the specified value to the VkDeviceGroupCommandBufferBeginInfo#pNext field.

selfback to summary
protected VkDeviceGroupCommandBufferBeginInfo.Buffer self()

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

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkDeviceGroupCommandBufferBeginInfo#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkDeviceGroupCommandBufferBeginInfo.Buffer sType(int value)

Sets the specified value to the VkDeviceGroupCommandBufferBeginInfo#sType field.

sType$Defaultback to summary
public VkDeviceGroupCommandBufferBeginInfo.Buffer sType$Default()

Sets the STRUCTURE_TYPE_DEVICE_GROUP_COMMAND_BUFFER_BEGIN_INFO value to the VkDeviceGroupCommandBufferBeginInfo#sType field.