Package org.lwjgl.vulkan

Class VkPipelineFragmentShadingRateStateCreateInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPipelineFragmentShadingRateStateCreateInfoKHR>

org.lwjgl.vulkan.VkPipelineFragmentShadingRateStateCreateInfoKHR

All Implemented Interfaces:

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

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

Structure specifying parameters controlling the fragment shading rate.

Description

If the pNext chain of VkGraphicsPipelineCreateInfo includes a VkPipelineFragmentShadingRateStateCreateInfoKHR structure, then that structure includes parameters controlling the pipeline fragment shading rate.

If this structure is not present, fragmentSize is considered to be equal to (1,1), and both elements of combinerOps are considered to be equal to FRAGMENT_SHADING_RATE_COMBINER_OP_KEEP_KHR.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_FRAGMENT_SHADING_RATE_STATE_CREATE_INFO_KHR

See Also

VkExtent2D

Layout

 struct VkPipelineFragmentShadingRateStateCreateInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkExtent2D fragmentSize();
     VkFragmentShadingRateCombinerOpKHR combinerOps()[2];
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkPipelineFragmentShadingRateStateCreateInfoKHR	calloc()	Returns a new VkPipelineFragmentShadingRateStateCreateInfoKHR instance allocated with memCalloc.
static VkPipelineFragmentShadingRateStateCreateInfoKHR.Buffer	calloc(int capacity)	Returns a new VkPipelineFragmentShadingRateStateCreateInfoKHR.Buffer instance allocated with memCalloc.
static VkPipelineFragmentShadingRateStateCreateInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineFragmentShadingRateStateCreateInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineFragmentShadingRateStateCreateInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineFragmentShadingRateStateCreateInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
IntBuffer	combinerOps()	specifies a VkFragmentShadingRateCombinerOpKHR value determining how the pipeline, primitive, and attachment shading rates are combined for fragments generated by drawing commands using the created pipeline.
int	combinerOps(int index)	specifies a VkFragmentShadingRateCombinerOpKHR value determining how the pipeline, primitive, and attachment shading rates are combined for fragments generated by drawing commands using the created pipeline.
VkPipelineFragmentShadingRateStateCreateInfoKHR	combinerOps(int index, int value)	Sets the specified value at the specified index of the combinerOps() field.
VkPipelineFragmentShadingRateStateCreateInfoKHR	combinerOps(IntBuffer value)	Copies the specified IntBuffer to the combinerOps() field.
static VkPipelineFragmentShadingRateStateCreateInfoKHR	create()	Returns a new VkPipelineFragmentShadingRateStateCreateInfoKHR instance allocated with BufferUtils.
static VkPipelineFragmentShadingRateStateCreateInfoKHR.Buffer	create(int capacity)	Returns a new VkPipelineFragmentShadingRateStateCreateInfoKHR.Buffer instance allocated with BufferUtils.
static VkPipelineFragmentShadingRateStateCreateInfoKHR	create(long address)	Returns a new VkPipelineFragmentShadingRateStateCreateInfoKHR instance for the specified memory address.
static VkPipelineFragmentShadingRateStateCreateInfoKHR.Buffer	create(long address, int capacity)	Create a VkPipelineFragmentShadingRateStateCreateInfoKHR.Buffer instance at the specified memory.
static @Nullable VkPipelineFragmentShadingRateStateCreateInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPipelineFragmentShadingRateStateCreateInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkExtent2D	fragmentSize()	specifies a VkExtent2D structure containing the fragment size used to define the pipeline fragment shading rate for drawing commands using this pipeline.
VkPipelineFragmentShadingRateStateCreateInfoKHR	fragmentSize(Consumer<VkExtent2D> consumer)	Passes the fragmentSize() field to the specified Consumer.
VkPipelineFragmentShadingRateStateCreateInfoKHR	fragmentSize(VkExtent2D value)	Copies the specified VkExtent2D to the fragmentSize() field.
static VkPipelineFragmentShadingRateStateCreateInfoKHR	malloc()	Returns a new VkPipelineFragmentShadingRateStateCreateInfoKHR instance allocated with memAlloc.
static VkPipelineFragmentShadingRateStateCreateInfoKHR.Buffer	malloc(int capacity)	Returns a new VkPipelineFragmentShadingRateStateCreateInfoKHR.Buffer instance allocated with memAlloc.
static VkPipelineFragmentShadingRateStateCreateInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineFragmentShadingRateStateCreateInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkPipelineFragmentShadingRateStateCreateInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineFragmentShadingRateStateCreateInfoKHR instance allocated on the specified MemoryStack.
static IntBuffer	ncombinerOps(long struct)	Unsafe version of combinerOps().
static int	ncombinerOps(long struct, int index)	Unsafe version of combinerOps.
static void	ncombinerOps(long struct, int index, int value)	Unsafe version of combinerOps.
static void	ncombinerOps(long struct, IntBuffer value)	Unsafe version of combinerOps.
static VkExtent2D	nfragmentSize(long struct)	Unsafe version of fragmentSize().
static void	nfragmentSize(long struct, VkExtent2D value)	Unsafe version of fragmentSize.
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.
VkPipelineFragmentShadingRateStateCreateInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkPipelineFragmentShadingRateStateCreateInfoKHR	set(int sType, long pNext, VkExtent2D fragmentSize, IntBuffer combinerOps)	Initializes this struct with the specified values.
VkPipelineFragmentShadingRateStateCreateInfoKHR	set(VkPipelineFragmentShadingRateStateCreateInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPipelineFragmentShadingRateStateCreateInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkPipelineFragmentShadingRateStateCreateInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_PIPELINE_FRAGMENT_SHADING_RATE_STATE_CREATE_INFO_KHR 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.

FRAGMENTSIZE

public static final int FRAGMENTSIZE

The struct member offsets.

COMBINEROPS

public static final int COMBINEROPS

The struct member offsets.

Constructor Details

VkPipelineFragmentShadingRateStateCreateInfoKHR

public VkPipelineFragmentShadingRateStateCreateInfoKHR(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

fragmentSize

public VkExtent2D fragmentSize()

specifies a VkExtent2D structure containing the fragment size used to define the pipeline fragment shading rate for drawing commands using this pipeline.

combinerOps

public IntBuffer combinerOps()

specifies a VkFragmentShadingRateCombinerOpKHR value determining how the pipeline, primitive, and attachment shading rates are combined for fragments generated by drawing commands using the created pipeline.

combinerOps

public int combinerOps(int index)

specifies a VkFragmentShadingRateCombinerOpKHR value determining how the pipeline, primitive, and attachment shading rates are combined for fragments generated by drawing commands using the created pipeline.

sType

public VkPipelineFragmentShadingRateStateCreateInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPipelineFragmentShadingRateStateCreateInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_PIPELINE_FRAGMENT_SHADING_RATE_STATE_CREATE_INFO_KHR value to the sType() field.

pNext

public VkPipelineFragmentShadingRateStateCreateInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

fragmentSize

public VkPipelineFragmentShadingRateStateCreateInfoKHR fragmentSize(VkExtent2D value)

Copies the specified VkExtent2D to the fragmentSize() field.

fragmentSize

public VkPipelineFragmentShadingRateStateCreateInfoKHR fragmentSize(Consumer<VkExtent2D> consumer)

Passes the fragmentSize() field to the specified Consumer.

combinerOps

public VkPipelineFragmentShadingRateStateCreateInfoKHR combinerOps(IntBuffer value)

Copies the specified IntBuffer to the combinerOps() field.

combinerOps

public VkPipelineFragmentShadingRateStateCreateInfoKHR combinerOps(int index,
 int value)

Sets the specified value at the specified index of the combinerOps() field.

set

public VkPipelineFragmentShadingRateStateCreateInfoKHR set(int sType,
 long pNext,
 VkExtent2D fragmentSize,
 IntBuffer combinerOps)

Initializes this struct with the specified values.

set

public VkPipelineFragmentShadingRateStateCreateInfoKHR set(VkPipelineFragmentShadingRateStateCreateInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPipelineFragmentShadingRateStateCreateInfoKHR malloc()

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

calloc

public static VkPipelineFragmentShadingRateStateCreateInfoKHR calloc()

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

create

public static VkPipelineFragmentShadingRateStateCreateInfoKHR create()

Returns a new VkPipelineFragmentShadingRateStateCreateInfoKHR instance allocated with BufferUtils.

create

public static VkPipelineFragmentShadingRateStateCreateInfoKHR create(long address)

Returns a new VkPipelineFragmentShadingRateStateCreateInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkPipelineFragmentShadingRateStateCreateInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPipelineFragmentShadingRateStateCreateInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPipelineFragmentShadingRateStateCreateInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPipelineFragmentShadingRateStateCreateInfoKHR.Buffer create(int capacity)

Returns a new VkPipelineFragmentShadingRateStateCreateInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPipelineFragmentShadingRateStateCreateInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkPipelineFragmentShadingRateStateCreateInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nfragmentSize

public static VkExtent2D nfragmentSize(long struct)

Unsafe version of fragmentSize().

ncombinerOps

public static IntBuffer ncombinerOps(long struct)

Unsafe version of combinerOps().

ncombinerOps

public static int ncombinerOps(long struct,
 int index)

Unsafe version of combinerOps.

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.

nfragmentSize

public static void nfragmentSize(long struct,
 VkExtent2D value)

Unsafe version of fragmentSize.

ncombinerOps

public static void ncombinerOps(long struct,
 IntBuffer value)

Unsafe version of combinerOps.

ncombinerOps

public static void ncombinerOps(long struct,
 int index,
 int value)

Unsafe version of combinerOps.