Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPhysicalDeviceSubgroupSizeControlProperties

extends Struct<VkPhysicalDeviceSubgroupSizeControlProperties>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkPhysicalDeviceSubgroupSizeControlPropertiesEXT
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure describing the control subgroup size properties of an implementation.
Description

If the VkPhysicalDeviceSubgroupSizeControlProperties structure is included in the pNext chain of the VkPhysicalDeviceProperties2 structure passed to GetPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

If VkPhysicalDeviceSubgroupProperties::supportedOperations includes SUBGROUP_FEATURE_QUAD_BIT, minSubgroupSize must be greater than or equal to 4.

Valid Usage (Implicit)

Layout


struct VkPhysicalDeviceSubgroupSizeControlProperties {
    VkStructureType sType;
    void * pNext;
    uint32_t minSubgroupSize;
    uint32_t maxSubgroupSize;
    uint32_t maxComputeWorkgroupSubgroups;
    VkShaderStageFlags requiredSubgroupSizeStages;
}

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
MAXCOMPUTEWORKGROUPSUBGROUPS

The struct member offsets.

public static final int
MAXSUBGROUPSIZE

The struct member offsets.

public static final int
MINSUBGROUPSIZE

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
REQUIREDSUBGROUPSIZESTAGES

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

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

Method Summary

Modifier and TypeMethod and Description
public static VkPhysicalDeviceSubgroupSizeControlProperties
calloc()

Returns a new VkPhysicalDeviceSubgroupSizeControlProperties instance allocated with memCalloc.

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

Returns a new VkPhysicalDeviceSubgroupSizeControlProperties.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkPhysicalDeviceSubgroupSizeControlProperties
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 VkPhysicalDeviceSubgroupSizeControlProperties
create()

Returns a new VkPhysicalDeviceSubgroupSizeControlProperties instance allocated with BufferUtils.

public static VkPhysicalDeviceSubgroupSizeControlProperties
create(long address)

Returns a new VkPhysicalDeviceSubgroupSizeControlProperties instance for the specified memory address.

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

Returns a new VkPhysicalDeviceSubgroupSizeControlProperties.Buffer instance allocated with BufferUtils.

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

Create a VkPhysicalDeviceSubgroupSizeControlProperties.Buffer instance at the specified memory.

public static VkPhysicalDeviceSubgroupSizeControlProperties
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkPhysicalDeviceSubgroupSizeControlProperties
malloc()

Returns a new VkPhysicalDeviceSubgroupSizeControlProperties instance allocated with memAlloc.

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

Returns a new VkPhysicalDeviceSubgroupSizeControlProperties.Buffer instance allocated with memAlloc.

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

Returns a new VkPhysicalDeviceSubgroupSizeControlProperties instance allocated on the specified MemoryStack.

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

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

public int
maxComputeWorkgroupSubgroups()

the maximum number of subgroups supported by the implementation within a workgroup.

public int
maxSubgroupSize()

the maximum subgroup size supported by this device.

public int
minSubgroupSize()

the minimum subgroup size supported by this device.

public static int
public static int
nmaxSubgroupSize(long struct)

Unsafe version of maxSubgroupSize.

public static int
nminSubgroupSize(long struct)

Unsafe version of minSubgroupSize.

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

Sets the specified value to the pNext field.

public int
requiredSubgroupSizeStages()

a bitfield of what shader stages support having a required subgroup size specified.

public VkPhysicalDeviceSubgroupSizeControlProperties
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkPhysicalDeviceSubgroupSizeControlProperties

Returns:

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

Sets the specified value to the sType field.

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

MAXCOMPUTEWORKGROUPSUBGROUPSback to summary
public static final int MAXCOMPUTEWORKGROUPSUBGROUPS

The struct member offsets.

MAXSUBGROUPSIZEback to summary
public static final int MAXSUBGROUPSIZE

The struct member offsets.

MINSUBGROUPSIZEback to summary
public static final int MINSUBGROUPSIZE

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

REQUIREDSUBGROUPSIZESTAGESback to summary
public static final int REQUIREDSUBGROUPSIZESTAGES

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

VkPhysicalDeviceSubgroupSizeControlPropertiesback to summary
protected VkPhysicalDeviceSubgroupSizeControlProperties(long address, ByteBuffer container)
VkPhysicalDeviceSubgroupSizeControlPropertiesback to summary
public VkPhysicalDeviceSubgroupSizeControlProperties(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkPhysicalDeviceSubgroupSizeControlProperties calloc(MemoryStack stack)

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

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

createback to summary
protected VkPhysicalDeviceSubgroupSizeControlProperties 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 VkPhysicalDeviceSubgroupSizeControlProperties create()

Returns a new VkPhysicalDeviceSubgroupSizeControlProperties instance allocated with BufferUtils.

createback to summary
public static VkPhysicalDeviceSubgroupSizeControlProperties create(long address)

Returns a new VkPhysicalDeviceSubgroupSizeControlProperties instance for the specified memory address.

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

Returns a new VkPhysicalDeviceSubgroupSizeControlProperties.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkPhysicalDeviceSubgroupSizeControlProperties.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkPhysicalDeviceSubgroupSizeControlProperties createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkPhysicalDeviceSubgroupSizeControlProperties malloc(MemoryStack stack)

Returns a new VkPhysicalDeviceSubgroupSizeControlProperties instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

maxComputeWorkgroupSubgroupsback to summary
public int maxComputeWorkgroupSubgroups()

the maximum number of subgroups supported by the implementation within a workgroup.

Annotations
@NativeType:uint32_t
maxSubgroupSizeback to summary
public int maxSubgroupSize()

the maximum subgroup size supported by this device. maxSubgroupSize is at least one if any of the physical device’s queues support QUEUE_GRAPHICS_BIT or QUEUE_COMPUTE_BIT. maxSubgroupSize is a power-of-two. maxSubgroupSize is greater than or equal to minSubgroupSize. maxSubgroupSize is greater than or equal to subgroupSize.

Annotations
@NativeType:uint32_t
minSubgroupSizeback to summary
public int minSubgroupSize()

the minimum subgroup size supported by this device. minSubgroupSize is at least one if any of the physical device’s queues support QUEUE_GRAPHICS_BIT or QUEUE_COMPUTE_BIT. minSubgroupSize is a power-of-two. minSubgroupSize is less than or equal to maxSubgroupSize. minSubgroupSize is less than or equal to subgroupSize.

Annotations
@NativeType:uint32_t
nmaxComputeWorkgroupSubgroupsback to summary
public static int nmaxComputeWorkgroupSubgroups(long struct)

Unsafe version of maxComputeWorkgroupSubgroups.

nmaxSubgroupSizeback to summary
public static int nmaxSubgroupSize(long struct)

Unsafe version of maxSubgroupSize.

nminSubgroupSizeback to summary
public static int nminSubgroupSize(long struct)

Unsafe version of minSubgroupSize.

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.

nrequiredSubgroupSizeStagesback to summary
public static int nrequiredSubgroupSizeStages(long struct)

Unsafe version of requiredSubgroupSizeStages.

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

Sets the specified value to the pNext field.

requiredSubgroupSizeStagesback to summary
public int requiredSubgroupSizeStages()

a bitfield of what shader stages support having a required subgroup size specified.

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

Initializes this struct with the specified values.

setback to summary
public VkPhysicalDeviceSubgroupSizeControlProperties set(VkPhysicalDeviceSubgroupSizeControlProperties src)

Copies the specified struct data to this struct.

Parameters
src:VkPhysicalDeviceSubgroupSizeControlProperties

the source struct

Returns:VkPhysicalDeviceSubgroupSizeControlProperties

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_SUBGROUP_SIZE_CONTROL_PROPERTIES value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkPhysicalDeviceSubgroupSizeControlProperties.Buffer

extends StructBuffer<VkPhysicalDeviceSubgroupSizeControlProperties, VkPhysicalDeviceSubgroupSizeControlProperties.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkPhysicalDeviceSubgroupSizeControlPropertiesEXT.Buffer

An array of VkPhysicalDeviceSubgroupSizeControlProperties structs.

Field Summary

Modifier and TypeField and Description
private static final VkPhysicalDeviceSubgroupSizeControlProperties

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkPhysicalDeviceSubgroupSizeControlProperties.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 VkPhysicalDeviceSubgroupSizeControlProperties
public int
public int
public int
public long
public VkPhysicalDeviceSubgroupSizeControlProperties.Buffer
pNext(long value)

Sets the specified value to the VkPhysicalDeviceSubgroupSizeControlProperties#pNext field.

public int
protected VkPhysicalDeviceSubgroupSizeControlProperties.Buffer
public int
public VkPhysicalDeviceSubgroupSizeControlProperties.Buffer
sType(int value)

Sets the specified value to the VkPhysicalDeviceSubgroupSizeControlProperties#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkPhysicalDeviceSubgroupSizeControlProperties ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkPhysicalDeviceSubgroupSizeControlProperties.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 VkPhysicalDeviceSubgroupSizeControlProperties#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 VkPhysicalDeviceSubgroupSizeControlProperties getElementFactory()

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

Annotations
@Override
maxComputeWorkgroupSubgroupsback to summary
public int maxComputeWorkgroupSubgroups()
Returns:int

the value of the VkPhysicalDeviceSubgroupSizeControlProperties#maxComputeWorkgroupSubgroups field.

Annotations
@NativeType:uint32_t
maxSubgroupSizeback to summary
public int maxSubgroupSize()
Returns:int

the value of the VkPhysicalDeviceSubgroupSizeControlProperties#maxSubgroupSize field.

Annotations
@NativeType:uint32_t
minSubgroupSizeback to summary
public int minSubgroupSize()
Returns:int

the value of the VkPhysicalDeviceSubgroupSizeControlProperties#minSubgroupSize field.

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

the value of the VkPhysicalDeviceSubgroupSizeControlProperties#pNext field.

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

Sets the specified value to the VkPhysicalDeviceSubgroupSizeControlProperties#pNext field.

requiredSubgroupSizeStagesback to summary
public int requiredSubgroupSizeStages()
Returns:int

the value of the VkPhysicalDeviceSubgroupSizeControlProperties#requiredSubgroupSizeStages field.

Annotations
@NativeType:VkShaderStageFlags
selfback to summary
protected VkPhysicalDeviceSubgroupSizeControlProperties.Buffer self()

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

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

the value of the VkPhysicalDeviceSubgroupSizeControlProperties#sType field.

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

Sets the specified value to the VkPhysicalDeviceSubgroupSizeControlProperties#sType field.

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

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_SUBGROUP_SIZE_CONTROL_PROPERTIES value to the VkPhysicalDeviceSubgroupSizeControlProperties#sType field.