Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkDeviceGroupPresentCapabilitiesKHR

extends Struct<VkDeviceGroupPresentCapabilitiesKHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Present capabilities from other physical devices.
Description

modes always has DEVICE_GROUP_PRESENT_MODE_LOCAL_BIT_KHR set.

The present mode flags are also used when presenting an image, in VkDeviceGroupPresentInfoKHR::mode.

If a device group only includes a single physical device, then modes must equal DEVICE_GROUP_PRESENT_MODE_LOCAL_BIT_KHR.

Valid Usage (Implicit)
See Also

GetDeviceGroupPresentCapabilitiesKHR

Layout


struct VkDeviceGroupPresentCapabilitiesKHR {
    VkStructureType sType;
    void * pNext;
    uint32_t presentMask[VK_MAX_DEVICE_GROUP_SIZE];
    VkDeviceGroupPresentModeFlagsKHR modes;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
MODES

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
PRESENTMASK

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
public
VkDeviceGroupPresentCapabilitiesKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkDeviceGroupPresentCapabilitiesKHR
calloc()

Returns a new VkDeviceGroupPresentCapabilitiesKHR instance allocated with memCalloc.

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

Returns a new VkDeviceGroupPresentCapabilitiesKHR.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkDeviceGroupPresentCapabilitiesKHR
callocStack()

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

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

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

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

Returns a new VkDeviceGroupPresentCapabilitiesKHR instance allocated with BufferUtils.

public static VkDeviceGroupPresentCapabilitiesKHR
create(long address)

Returns a new VkDeviceGroupPresentCapabilitiesKHR instance for the specified memory address.

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

Returns a new VkDeviceGroupPresentCapabilitiesKHR.Buffer instance allocated with BufferUtils.

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

Create a VkDeviceGroupPresentCapabilitiesKHR.Buffer instance at the specified memory.

public static VkDeviceGroupPresentCapabilitiesKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkDeviceGroupPresentCapabilitiesKHR
malloc()

Returns a new VkDeviceGroupPresentCapabilitiesKHR instance allocated with memAlloc.

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

Returns a new VkDeviceGroupPresentCapabilitiesKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkDeviceGroupPresentCapabilitiesKHR instance allocated on the specified MemoryStack.

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

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

public static VkDeviceGroupPresentCapabilitiesKHR
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public int
modes()

a bitmask of VkDeviceGroupPresentModeFlagBitsKHR indicating which device group presentation modes are supported.

public static int
nmodes(long struct)

Unsafe version of modes.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static IntBuffer
npresentMask(long struct)

Unsafe version of presentMask.

public static int
npresentMask(long struct, int index)

Unsafe version of presentMask.

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 VkDeviceGroupPresentCapabilitiesKHR
pNext(long value)

Sets the specified value to the pNext field.

public IntBuffer
presentMask()

an array of MAX_DEVICE_GROUP_SIZE uint32_t masks, where the mask at element i is non-zero if physical device i has a presentation engine, and where bit j is set in element i if physical device i can present swapchain images from physical device j.

public int
presentMask(int index)

an array of MAX_DEVICE_GROUP_SIZE uint32_t masks, where the mask at element i is non-zero if physical device i has a presentation engine, and where bit j is set in element i if physical device i can present swapchain images from physical device j.

public VkDeviceGroupPresentCapabilitiesKHR
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkDeviceGroupPresentCapabilitiesKHR

Returns:

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

Sets the specified value to the sType field.

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

MODESback to summary
public static final int MODES

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

PRESENTMASKback to summary
public static final int PRESENTMASK

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

VkDeviceGroupPresentCapabilitiesKHRback to summary
protected VkDeviceGroupPresentCapabilitiesKHR(long address, ByteBuffer container)
VkDeviceGroupPresentCapabilitiesKHRback to summary
public VkDeviceGroupPresentCapabilitiesKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkDeviceGroupPresentCapabilitiesKHR calloc(MemoryStack stack)

Returns a new VkDeviceGroupPresentCapabilitiesKHR 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 VkDeviceGroupPresentCapabilitiesKHR.Buffer calloc(int capacity, MemoryStack stack)

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkDeviceGroupPresentCapabilitiesKHR.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 VkDeviceGroupPresentCapabilitiesKHR 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 VkDeviceGroupPresentCapabilitiesKHR create()

Returns a new VkDeviceGroupPresentCapabilitiesKHR instance allocated with BufferUtils.

createback to summary
public static VkDeviceGroupPresentCapabilitiesKHR create(long address)

Returns a new VkDeviceGroupPresentCapabilitiesKHR instance for the specified memory address.

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

Returns a new VkDeviceGroupPresentCapabilitiesKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkDeviceGroupPresentCapabilitiesKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkDeviceGroupPresentCapabilitiesKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkDeviceGroupPresentCapabilitiesKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkDeviceGroupPresentCapabilitiesKHR malloc(MemoryStack stack)

Returns a new VkDeviceGroupPresentCapabilitiesKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
modesback to summary
public int modes()

a bitmask of VkDeviceGroupPresentModeFlagBitsKHR indicating which device group presentation modes are supported.

Annotations
@NativeType:VkDeviceGroupPresentModeFlagsKHR
nmodesback to summary
public static int nmodes(long struct)

Unsafe version of modes.

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.

npresentMaskback to summary
public static IntBuffer npresentMask(long struct)

Unsafe version of presentMask.

npresentMaskback to summary
public static int npresentMask(long struct, int index)

Unsafe version of presentMask.

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 *
pNextback to summary
public VkDeviceGroupPresentCapabilitiesKHR pNext(long value)

Sets the specified value to the pNext field.

presentMaskback to summary
public IntBuffer presentMask()

an array of MAX_DEVICE_GROUP_SIZE uint32_t masks, where the mask at element i is non-zero if physical device i has a presentation engine, and where bit j is set in element i if physical device i can present swapchain images from physical device j. If element i is non-zero, then bit i must be set.

Annotations
@NativeType:uint32_t[VK_MAX_DEVICE_GROUP_SIZE]
presentMaskback to summary
public int presentMask(int index)

an array of MAX_DEVICE_GROUP_SIZE uint32_t masks, where the mask at element i is non-zero if physical device i has a presentation engine, and where bit j is set in element i if physical device i can present swapchain images from physical device j. If element i is non-zero, then bit i must be set.

Annotations
@NativeType:uint32_t
setback to summary
public VkDeviceGroupPresentCapabilitiesKHR set(int sType, long pNext)

Initializes this struct with the specified values.

setback to summary
public VkDeviceGroupPresentCapabilitiesKHR set(VkDeviceGroupPresentCapabilitiesKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkDeviceGroupPresentCapabilitiesKHR

the source struct

Returns:VkDeviceGroupPresentCapabilitiesKHR

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 VkDeviceGroupPresentCapabilitiesKHR sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_DEVICE_GROUP_PRESENT_CAPABILITIES_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkDeviceGroupPresentCapabilitiesKHR.Buffer

extends StructBuffer<VkDeviceGroupPresentCapabilitiesKHR, VkDeviceGroupPresentCapabilitiesKHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkDeviceGroupPresentCapabilitiesKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkDeviceGroupPresentCapabilitiesKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkDeviceGroupPresentCapabilitiesKHR.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
protected VkDeviceGroupPresentCapabilitiesKHR
public int

Returns:

the value of the VkDeviceGroupPresentCapabilitiesKHR#modes field.
modes
()

public long

Returns:

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

public VkDeviceGroupPresentCapabilitiesKHR.Buffer
pNext(long value)

Sets the specified value to the VkDeviceGroupPresentCapabilitiesKHR#pNext field.

public IntBuffer
public int

Returns:

the value at the specified index of the VkDeviceGroupPresentCapabilitiesKHR#presentMask field.
presentMask
(int index)

protected VkDeviceGroupPresentCapabilitiesKHR.Buffer
public int

Returns:

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

public VkDeviceGroupPresentCapabilitiesKHR.Buffer
sType(int value)

Sets the specified value to the VkDeviceGroupPresentCapabilitiesKHR#sType field.

public VkDeviceGroupPresentCapabilitiesKHR.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkDeviceGroupPresentCapabilitiesKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkDeviceGroupPresentCapabilitiesKHR.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 VkDeviceGroupPresentCapabilitiesKHR#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

getElementFactoryback to summary
protected VkDeviceGroupPresentCapabilitiesKHR getElementFactory()

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

Annotations
@Override
modesback to summary
public int modes()
Returns:int

the value of the VkDeviceGroupPresentCapabilitiesKHR#modes field.

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

the value of the VkDeviceGroupPresentCapabilitiesKHR#pNext field.

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

Sets the specified value to the VkDeviceGroupPresentCapabilitiesKHR#pNext field.

presentMaskback to summary
public IntBuffer presentMask()
Returns:IntBuffer

a IntBuffer view of the VkDeviceGroupPresentCapabilitiesKHR#presentMask field.

Annotations
@NativeType:uint32_t[VK_MAX_DEVICE_GROUP_SIZE]
presentMaskback to summary
public int presentMask(int index)
Returns:int

the value at the specified index of the VkDeviceGroupPresentCapabilitiesKHR#presentMask field.

Annotations
@NativeType:uint32_t
selfback to summary
protected VkDeviceGroupPresentCapabilitiesKHR.Buffer self()

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

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

the value of the VkDeviceGroupPresentCapabilitiesKHR#sType field.

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

Sets the specified value to the VkDeviceGroupPresentCapabilitiesKHR#sType field.

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

Sets the STRUCTURE_TYPE_DEVICE_GROUP_PRESENT_CAPABILITIES_KHR value to the VkDeviceGroupPresentCapabilitiesKHR#sType field.