Package org.lwjgl.vulkan

Class VkExecutionGraphPipelineScratchSizeAMDX

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkExecutionGraphPipelineScratchSizeAMDX>

org.lwjgl.vulkan.VkExecutionGraphPipelineScratchSizeAMDX

All Implemented Interfaces:

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

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

Structure describing the scratch space required to dispatch an execution graph.

Description

Applications can use any amount of scratch memory greater than minSize for dispatching a graph, however only the values equal to minSize + an integer multiple of sizeGranularity will be used. Greater values may result in higher performance, up to maxSize which indicates the most memory that an implementation can use effectively.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_EXECUTION_GRAPH_PIPELINE_SCRATCH_SIZE_AMDX

See Also

GetExecutionGraphPipelineScratchSizeAMDX

Layout

 struct VkExecutionGraphPipelineScratchSizeAMDX {
     VkStructureType sType();
     void * pNext();
     VkDeviceSize minSize();
     VkDeviceSize maxSize();
     VkDeviceSize sizeGranularity();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkExecutionGraphPipelineScratchSizeAMDX.Buffer	An array of VkExecutionGraphPipelineScratchSizeAMDX 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	MAXSIZE	The struct member offsets.
static final int	MINSIZE	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEGRANULARITY	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
VkExecutionGraphPipelineScratchSizeAMDX(ByteBuffer container)	Creates a VkExecutionGraphPipelineScratchSizeAMDX instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkExecutionGraphPipelineScratchSizeAMDX	calloc()	Returns a new VkExecutionGraphPipelineScratchSizeAMDX instance allocated with memCalloc.
static VkExecutionGraphPipelineScratchSizeAMDX.Buffer	calloc(int capacity)	Returns a new VkExecutionGraphPipelineScratchSizeAMDX.Buffer instance allocated with memCalloc.
static VkExecutionGraphPipelineScratchSizeAMDX.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkExecutionGraphPipelineScratchSizeAMDX.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkExecutionGraphPipelineScratchSizeAMDX	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkExecutionGraphPipelineScratchSizeAMDX instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkExecutionGraphPipelineScratchSizeAMDX	create()	Returns a new VkExecutionGraphPipelineScratchSizeAMDX instance allocated with BufferUtils.
static VkExecutionGraphPipelineScratchSizeAMDX.Buffer	create(int capacity)	Returns a new VkExecutionGraphPipelineScratchSizeAMDX.Buffer instance allocated with BufferUtils.
static VkExecutionGraphPipelineScratchSizeAMDX	create(long address)	Returns a new VkExecutionGraphPipelineScratchSizeAMDX instance for the specified memory address.
static VkExecutionGraphPipelineScratchSizeAMDX.Buffer	create(long address, int capacity)	Create a VkExecutionGraphPipelineScratchSizeAMDX.Buffer instance at the specified memory.
static @Nullable VkExecutionGraphPipelineScratchSizeAMDX	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkExecutionGraphPipelineScratchSizeAMDX.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkExecutionGraphPipelineScratchSizeAMDX	malloc()	Returns a new VkExecutionGraphPipelineScratchSizeAMDX instance allocated with memAlloc.
static VkExecutionGraphPipelineScratchSizeAMDX.Buffer	malloc(int capacity)	Returns a new VkExecutionGraphPipelineScratchSizeAMDX.Buffer instance allocated with memAlloc.
static VkExecutionGraphPipelineScratchSizeAMDX.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkExecutionGraphPipelineScratchSizeAMDX.Buffer instance allocated on the specified MemoryStack.
static VkExecutionGraphPipelineScratchSizeAMDX	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkExecutionGraphPipelineScratchSizeAMDX instance allocated on the specified MemoryStack.
long	maxSize()	indicates the maximum scratch space that can be used for dispatching the queried execution graph.
VkExecutionGraphPipelineScratchSizeAMDX	maxSize(long value)	Sets the specified value to the maxSize() field.
long	minSize()	indicates the minimum scratch space required for dispatching the queried execution graph.
VkExecutionGraphPipelineScratchSizeAMDX	minSize(long value)	Sets the specified value to the minSize() field.
static long	nmaxSize(long struct)	Unsafe version of maxSize().
static void	nmaxSize(long struct, long value)	Unsafe version of maxSize.
static long	nminSize(long struct)	Unsafe version of minSize().
static void	nminSize(long struct, long value)	Unsafe version of minSize.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static long	nsizeGranularity(long struct)	Unsafe version of sizeGranularity().
static void	nsizeGranularity(long struct, long value)	Unsafe version of sizeGranularity.
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.
VkExecutionGraphPipelineScratchSizeAMDX	pNext(long value)	Sets the specified value to the pNext() field.
VkExecutionGraphPipelineScratchSizeAMDX	set(int sType, long pNext, long minSize, long maxSize, long sizeGranularity)	Initializes this struct with the specified values.
VkExecutionGraphPipelineScratchSizeAMDX	set(VkExecutionGraphPipelineScratchSizeAMDX src)	Copies the specified struct data to this struct.
long	sizeGranularity()	indicates the granularity at which the scratch space can be increased from minSize.
VkExecutionGraphPipelineScratchSizeAMDX	sizeGranularity(long value)	Sets the specified value to the sizeGranularity() field.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkExecutionGraphPipelineScratchSizeAMDX	sType(int value)	Sets the specified value to the sType() field.
VkExecutionGraphPipelineScratchSizeAMDX	sType$Default()	Sets the STRUCTURE_TYPE_EXECUTION_GRAPH_PIPELINE_SCRATCH_SIZE_AMDX 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.

MINSIZE

public static final int MINSIZE

The struct member offsets.

MAXSIZE

public static final int MAXSIZE

The struct member offsets.

SIZEGRANULARITY

public static final int SIZEGRANULARITY

The struct member offsets.

Constructor Details

VkExecutionGraphPipelineScratchSizeAMDX

public VkExecutionGraphPipelineScratchSizeAMDX(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

minSize

public long minSize()

indicates the minimum scratch space required for dispatching the queried execution graph.

maxSize

public long maxSize()

indicates the maximum scratch space that can be used for dispatching the queried execution graph.

sizeGranularity

public long sizeGranularity()

indicates the granularity at which the scratch space can be increased from minSize.

sType

public VkExecutionGraphPipelineScratchSizeAMDX sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkExecutionGraphPipelineScratchSizeAMDX sType$Default()

Sets the STRUCTURE_TYPE_EXECUTION_GRAPH_PIPELINE_SCRATCH_SIZE_AMDX value to the sType() field.

pNext

public VkExecutionGraphPipelineScratchSizeAMDX pNext(long value)

Sets the specified value to the pNext() field.

minSize

public VkExecutionGraphPipelineScratchSizeAMDX minSize(long value)

Sets the specified value to the minSize() field.

maxSize

public VkExecutionGraphPipelineScratchSizeAMDX maxSize(long value)

Sets the specified value to the maxSize() field.

sizeGranularity

public VkExecutionGraphPipelineScratchSizeAMDX sizeGranularity(long value)

Sets the specified value to the sizeGranularity() field.

set

public VkExecutionGraphPipelineScratchSizeAMDX set(int sType,
 long pNext,
 long minSize,
 long maxSize,
 long sizeGranularity)

Initializes this struct with the specified values.

set

public VkExecutionGraphPipelineScratchSizeAMDX set(VkExecutionGraphPipelineScratchSizeAMDX src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkExecutionGraphPipelineScratchSizeAMDX malloc()

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

calloc

public static VkExecutionGraphPipelineScratchSizeAMDX calloc()

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

create

public static VkExecutionGraphPipelineScratchSizeAMDX create()

Returns a new VkExecutionGraphPipelineScratchSizeAMDX instance allocated with BufferUtils.

create

public static VkExecutionGraphPipelineScratchSizeAMDX create(long address)

Returns a new VkExecutionGraphPipelineScratchSizeAMDX instance for the specified memory address.

createSafe

public static @Nullable VkExecutionGraphPipelineScratchSizeAMDX createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkExecutionGraphPipelineScratchSizeAMDX.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkExecutionGraphPipelineScratchSizeAMDX.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkExecutionGraphPipelineScratchSizeAMDX.Buffer create(int capacity)

Returns a new VkExecutionGraphPipelineScratchSizeAMDX.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkExecutionGraphPipelineScratchSizeAMDX.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkExecutionGraphPipelineScratchSizeAMDX instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nminSize

public static long nminSize(long struct)

Unsafe version of minSize().

nmaxSize

public static long nmaxSize(long struct)

Unsafe version of maxSize().

nsizeGranularity

public static long nsizeGranularity(long struct)

Unsafe version of sizeGranularity().

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.

nminSize

public static void nminSize(long struct,
 long value)

Unsafe version of minSize.

nmaxSize

public static void nmaxSize(long struct,
 long value)

Unsafe version of maxSize.

nsizeGranularity

public static void nsizeGranularity(long struct,
 long value)

Unsafe version of sizeGranularity.