Package org.lwjgl.vulkan

Class VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR>

org.lwjgl.vulkan.VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR

All Implemented Interfaces:

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

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

Structure describing the workgroup storage explicit layout features that can be supported by an implementation.

Description

If the VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR structure is included in the pNext chain of the VkPhysicalDeviceFeatures2 structure passed to GetPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR can also be used in the pNext chain of VkDeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_WORKGROUP_MEMORY_EXPLICIT_LAYOUT_FEATURES_KHR

Layout

 struct VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR {
     VkStructureType sType();
     void * pNext();
     VkBool32 workgroupMemoryExplicitLayout();
     VkBool32 workgroupMemoryExplicitLayoutScalarBlockLayout();
     VkBool32 workgroupMemoryExplicitLayout8BitAccess();
     VkBool32 workgroupMemoryExplicitLayout16BitAccess();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR.Buffer	An array of VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR 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	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.
static final int	WORKGROUPMEMORYEXPLICITLAYOUT	The struct member offsets.
static final int	WORKGROUPMEMORYEXPLICITLAYOUT16BITACCESS	The struct member offsets.
static final int	WORKGROUPMEMORYEXPLICITLAYOUT8BITACCESS	The struct member offsets.
static final int	WORKGROUPMEMORYEXPLICITLAYOUTSCALARBLOCKLAYOUT	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
VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR(ByteBuffer container)	Creates a VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR	calloc()	Returns a new VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR instance allocated with memCalloc.
static VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR	create()	Returns a new VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR instance allocated with BufferUtils.
static VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR	create(long address)	Returns a new VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR instance for the specified memory address.
static VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR.Buffer instance at the specified memory.
static @Nullable VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR	malloc()	Returns a new VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR instance allocated with memAlloc.
static VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR instance allocated on the specified MemoryStack.
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.
static int	nworkgroupMemoryExplicitLayout(long struct)	Unsafe version of workgroupMemoryExplicitLayout().
static void	nworkgroupMemoryExplicitLayout(long struct, int value)	Unsafe version of workgroupMemoryExplicitLayout.
static int	nworkgroupMemoryExplicitLayout16BitAccess(long struct)	Unsafe version of workgroupMemoryExplicitLayout16BitAccess().
static void	nworkgroupMemoryExplicitLayout16BitAccess(long struct, int value)	Unsafe version of workgroupMemoryExplicitLayout16BitAccess.
static int	nworkgroupMemoryExplicitLayout8BitAccess(long struct)	Unsafe version of workgroupMemoryExplicitLayout8BitAccess().
static void	nworkgroupMemoryExplicitLayout8BitAccess(long struct, int value)	Unsafe version of workgroupMemoryExplicitLayout8BitAccess.
static int	nworkgroupMemoryExplicitLayoutScalarBlockLayout(long struct)	Unsafe version of workgroupMemoryExplicitLayoutScalarBlockLayout().
static void	nworkgroupMemoryExplicitLayoutScalarBlockLayout(long struct, int value)	Unsafe version of workgroupMemoryExplicitLayoutScalarBlockLayout.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR	set(int sType, long pNext, boolean workgroupMemoryExplicitLayout, boolean workgroupMemoryExplicitLayoutScalarBlockLayout, boolean workgroupMemoryExplicitLayout8BitAccess, boolean workgroupMemoryExplicitLayout16BitAccess)	Initializes this struct with the specified values.
VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR	set(VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR	sType(int value)	Sets the specified value to the sType() field.
VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_WORKGROUP_MEMORY_EXPLICIT_LAYOUT_FEATURES_KHR value to the sType() field.
boolean	workgroupMemoryExplicitLayout()	indicates whether the implementation supports the SPIR-V WorkgroupMemoryExplicitLayoutKHR capability.
VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR	workgroupMemoryExplicitLayout(boolean value)	Sets the specified value to the workgroupMemoryExplicitLayout() field.
boolean	workgroupMemoryExplicitLayout16BitAccess()	indicates whether objects in the Workgroup storage class with the Block decoration can have 16-bit integer and 16-bit floating-point members.
VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR	workgroupMemoryExplicitLayout16BitAccess(boolean value)	Sets the specified value to the workgroupMemoryExplicitLayout16BitAccess() field.
boolean	workgroupMemoryExplicitLayout8BitAccess()	indicates whether objects in the Workgroup storage class with the Block decoration can have 8-bit integer members.
VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR	workgroupMemoryExplicitLayout8BitAccess(boolean value)	Sets the specified value to the workgroupMemoryExplicitLayout8BitAccess() field.
boolean	workgroupMemoryExplicitLayoutScalarBlockLayout()	indicates whether the implementation supports scalar alignment for laying out Workgroup Blocks.
VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR	workgroupMemoryExplicitLayoutScalarBlockLayout(boolean value)	Sets the specified value to the workgroupMemoryExplicitLayoutScalarBlockLayout() 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.

WORKGROUPMEMORYEXPLICITLAYOUT

public static final int WORKGROUPMEMORYEXPLICITLAYOUT

The struct member offsets.

WORKGROUPMEMORYEXPLICITLAYOUTSCALARBLOCKLAYOUT

public static final int WORKGROUPMEMORYEXPLICITLAYOUTSCALARBLOCKLAYOUT

The struct member offsets.

WORKGROUPMEMORYEXPLICITLAYOUT8BITACCESS

public static final int WORKGROUPMEMORYEXPLICITLAYOUT8BITACCESS

The struct member offsets.

WORKGROUPMEMORYEXPLICITLAYOUT16BITACCESS

public static final int WORKGROUPMEMORYEXPLICITLAYOUT16BITACCESS

The struct member offsets.

Constructor Details

VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR

public VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR(ByteBuffer container)

Creates a VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR 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<VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

workgroupMemoryExplicitLayout

public boolean workgroupMemoryExplicitLayout()

indicates whether the implementation supports the SPIR-V WorkgroupMemoryExplicitLayoutKHR capability.

workgroupMemoryExplicitLayoutScalarBlockLayout

public boolean workgroupMemoryExplicitLayoutScalarBlockLayout()

indicates whether the implementation supports scalar alignment for laying out Workgroup Blocks.

workgroupMemoryExplicitLayout8BitAccess

public boolean workgroupMemoryExplicitLayout8BitAccess()

indicates whether objects in the Workgroup storage class with the Block decoration can have 8-bit integer members. If this feature is not enabled, 8-bit integer members must not be used in such objects. This also indicates whether shader modules can declare the WorkgroupMemoryExplicitLayout8BitAccessKHR capability.

workgroupMemoryExplicitLayout16BitAccess

public boolean workgroupMemoryExplicitLayout16BitAccess()

indicates whether objects in the Workgroup storage class with the Block decoration can have 16-bit integer and 16-bit floating-point members. If this feature is not enabled, 16-bit integer or 16-bit floating-point members must not be used in such objects. This also indicates whether shader modules can declare the WorkgroupMemoryExplicitLayout16BitAccessKHR capability.

sType

public VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_WORKGROUP_MEMORY_EXPLICIT_LAYOUT_FEATURES_KHR value to the sType() field.

pNext

public VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR pNext(long value)

Sets the specified value to the pNext() field.

workgroupMemoryExplicitLayout

public VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR workgroupMemoryExplicitLayout(boolean value)

Sets the specified value to the workgroupMemoryExplicitLayout() field.

workgroupMemoryExplicitLayoutScalarBlockLayout

public VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR workgroupMemoryExplicitLayoutScalarBlockLayout(boolean value)

Sets the specified value to the workgroupMemoryExplicitLayoutScalarBlockLayout() field.

workgroupMemoryExplicitLayout8BitAccess

public VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR workgroupMemoryExplicitLayout8BitAccess(boolean value)

Sets the specified value to the workgroupMemoryExplicitLayout8BitAccess() field.

workgroupMemoryExplicitLayout16BitAccess

public VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR workgroupMemoryExplicitLayout16BitAccess(boolean value)

Sets the specified value to the workgroupMemoryExplicitLayout16BitAccess() field.

set

public VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR set(int sType,
 long pNext,
 boolean workgroupMemoryExplicitLayout,
 boolean workgroupMemoryExplicitLayoutScalarBlockLayout,
 boolean workgroupMemoryExplicitLayout8BitAccess,
 boolean workgroupMemoryExplicitLayout16BitAccess)

Initializes this struct with the specified values.

set

public VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR set(VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR malloc()

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

calloc

public static VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR calloc()

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

create

public static VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR create()

Returns a new VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR instance allocated with BufferUtils.

create

public static VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR create(long address)

Returns a new VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR instance for the specified memory address.

createSafe

public static @Nullable VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR.Buffer create(int capacity)

Returns a new VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nworkgroupMemoryExplicitLayout

public static int nworkgroupMemoryExplicitLayout(long struct)

Unsafe version of workgroupMemoryExplicitLayout().

nworkgroupMemoryExplicitLayoutScalarBlockLayout

public static int nworkgroupMemoryExplicitLayoutScalarBlockLayout(long struct)

Unsafe version of workgroupMemoryExplicitLayoutScalarBlockLayout().

nworkgroupMemoryExplicitLayout8BitAccess

public static int nworkgroupMemoryExplicitLayout8BitAccess(long struct)

Unsafe version of workgroupMemoryExplicitLayout8BitAccess().

nworkgroupMemoryExplicitLayout16BitAccess

public static int nworkgroupMemoryExplicitLayout16BitAccess(long struct)

Unsafe version of workgroupMemoryExplicitLayout16BitAccess().

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.

nworkgroupMemoryExplicitLayout

public static void nworkgroupMemoryExplicitLayout(long struct,
 int value)

Unsafe version of workgroupMemoryExplicitLayout.

nworkgroupMemoryExplicitLayoutScalarBlockLayout

public static void nworkgroupMemoryExplicitLayoutScalarBlockLayout(long struct,
 int value)

Unsafe version of workgroupMemoryExplicitLayoutScalarBlockLayout.

nworkgroupMemoryExplicitLayout8BitAccess

public static void nworkgroupMemoryExplicitLayout8BitAccess(long struct,
 int value)

Unsafe version of workgroupMemoryExplicitLayout8BitAccess.

nworkgroupMemoryExplicitLayout16BitAccess

public static void nworkgroupMemoryExplicitLayout16BitAccess(long struct,
 int value)

Unsafe version of workgroupMemoryExplicitLayout16BitAccess.