Package org.lwjgl.vulkan

Class VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI>

org.lwjgl.vulkan.VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI

All Implemented Interfaces:

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

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

Structure describing cluster culling shader properties supported by an implementation.

Description

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

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_CLUSTER_CULLING_SHADER_PROPERTIES_HUAWEI

Layout

 struct VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI {
     VkStructureType sType();
     void * pNext();
     uint32_t maxWorkGroupCount()[3];
     uint32_t maxWorkGroupSize()[3];
     uint32_t maxOutputClusterCount();
     VkDeviceSize indirectBufferOffsetAlignment();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI.Buffer	An array of VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI 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	INDIRECTBUFFEROFFSETALIGNMENT	The struct member offsets.
static final int	MAXOUTPUTCLUSTERCOUNT	The struct member offsets.
static final int	MAXWORKGROUPCOUNT	The struct member offsets.
static final int	MAXWORKGROUPSIZE	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
VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI(ByteBuffer container)	Creates a VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI	calloc()	Returns a new VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI instance allocated with memCalloc.
static VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI	create()	Returns a new VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI instance allocated with BufferUtils.
static VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI	create(long address)	Returns a new VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI instance for the specified memory address.
static VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI.Buffer instance at the specified memory.
static @Nullable VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	indirectBufferOffsetAlignment()	indicates the alignment for cluster drawing command buffer stride.
static VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI	malloc()	Returns a new VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI instance allocated with memAlloc.
static VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI instance allocated on the specified MemoryStack.
int	maxOutputClusterCount()	the maximum number of output cluster a single cluster culling shader workgroup can emit.
IntBuffer	maxWorkGroupCount()	the maximum number of local workgroups that can be launched by a single command.
int	maxWorkGroupCount(int index)	the maximum number of local workgroups that can be launched by a single command.
IntBuffer	maxWorkGroupSize()	the maximum size of a local workgroup.
int	maxWorkGroupSize(int index)	the maximum size of a local workgroup.
static long	nindirectBufferOffsetAlignment(long struct)	Unsafe version of indirectBufferOffsetAlignment().
static int	nmaxOutputClusterCount(long struct)	Unsafe version of maxOutputClusterCount().
static IntBuffer	nmaxWorkGroupCount(long struct)	Unsafe version of maxWorkGroupCount().
static int	nmaxWorkGroupCount(long struct, int index)	Unsafe version of maxWorkGroupCount.
static IntBuffer	nmaxWorkGroupSize(long struct)	Unsafe version of maxWorkGroupSize().
static int	nmaxWorkGroupSize(long struct, int index)	Unsafe version of maxWorkGroupSize.
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.
VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI	pNext(long value)	Sets the specified value to the pNext() field.
VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI	set(int sType, long pNext)	Initializes this struct with the specified values.
VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI	set(VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI	sType(int value)	Sets the specified value to the sType() field.
VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_CLUSTER_CULLING_SHADER_PROPERTIES_HUAWEI 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.

MAXWORKGROUPCOUNT

public static final int MAXWORKGROUPCOUNT

The struct member offsets.

MAXWORKGROUPSIZE

public static final int MAXWORKGROUPSIZE

The struct member offsets.

MAXOUTPUTCLUSTERCOUNT

public static final int MAXOUTPUTCLUSTERCOUNT

The struct member offsets.

INDIRECTBUFFEROFFSETALIGNMENT

public static final int INDIRECTBUFFEROFFSETALIGNMENT

The struct member offsets.

Constructor Details

VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI

public VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

maxWorkGroupCount

public IntBuffer maxWorkGroupCount()

the maximum number of local workgroups that can be launched by a single command. These three value represent the maximum local workgroup count in the X, Y and Z dimensions, respectively. In the current implementation, the values of Y and Z are both implicitly set as one. groupCountX of DrawCluster command must be less than or equal to maxWorkGroupCount[0].

maxWorkGroupCount

public int maxWorkGroupCount(int index)

the maximum number of local workgroups that can be launched by a single command. These three value represent the maximum local workgroup count in the X, Y and Z dimensions, respectively. In the current implementation, the values of Y and Z are both implicitly set as one. groupCountX of DrawCluster command must be less than or equal to maxWorkGroupCount[0].

maxWorkGroupSize

public IntBuffer maxWorkGroupSize()

the maximum size of a local workgroup. These three value represent the maximum local workgroup size in the X, Y and Z dimensions, respectively. The x, y and z sizes, as specified by the LocalSize or LocalSizeId execution mode or by the object decorated by the WorkgroupSize decoration in shader modules, must be less than or equal to the corresponding limit. In the current implementation, the maximum workgroup size of the X dimension is 32, the others are 1.

maxWorkGroupSize

public int maxWorkGroupSize(int index)

the maximum size of a local workgroup. These three value represent the maximum local workgroup size in the X, Y and Z dimensions, respectively. The x, y and z sizes, as specified by the LocalSize or LocalSizeId execution mode or by the object decorated by the WorkgroupSize decoration in shader modules, must be less than or equal to the corresponding limit. In the current implementation, the maximum workgroup size of the X dimension is 32, the others are 1.

maxOutputClusterCount

public int maxOutputClusterCount()

the maximum number of output cluster a single cluster culling shader workgroup can emit.

indirectBufferOffsetAlignment

public long indirectBufferOffsetAlignment()

indicates the alignment for cluster drawing command buffer stride. CmdDrawClusterIndirectHUAWEI::offset must be a multiple of this value.

sType

public VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_CLUSTER_CULLING_SHADER_PROPERTIES_HUAWEI value to the sType() field.

pNext

public VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI pNext(long value)

Sets the specified value to the pNext() field.

set

public VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI set(VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI malloc()

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

calloc

public static VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI calloc()

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

create

public static VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI create()

Returns a new VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI instance allocated with BufferUtils.

create

public static VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI create(long address)

Returns a new VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI instance for the specified memory address.

createSafe

public static @Nullable VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI.Buffer create(int capacity)

Returns a new VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkPhysicalDeviceClusterCullingShaderPropertiesHUAWEI instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nmaxWorkGroupCount

public static IntBuffer nmaxWorkGroupCount(long struct)

Unsafe version of maxWorkGroupCount().

nmaxWorkGroupCount

public static int nmaxWorkGroupCount(long struct,
 int index)

Unsafe version of maxWorkGroupCount.

nmaxWorkGroupSize

public static IntBuffer nmaxWorkGroupSize(long struct)

Unsafe version of maxWorkGroupSize().

nmaxWorkGroupSize

public static int nmaxWorkGroupSize(long struct,
 int index)

Unsafe version of maxWorkGroupSize.

nmaxOutputClusterCount

public static int nmaxOutputClusterCount(long struct)

Unsafe version of maxOutputClusterCount().

nindirectBufferOffsetAlignment

public static long nindirectBufferOffsetAlignment(long struct)

Unsafe version of indirectBufferOffsetAlignment().

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.