Package org.lwjgl.vulkan

Class VkSubpassFragmentDensityMapOffsetEndInfoQCOM

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkSubpassFragmentDensityMapOffsetEndInfoQCOM>

org.lwjgl.vulkan.VkSubpassFragmentDensityMapOffsetEndInfoQCOM

All Implemented Interfaces:

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

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

Structure specifying fragment density map offset subpass end information.

Description

The array elements are given per layer as defined by Fetch Density Value, where index = layer. Each (x,y) offset is in framebuffer pixels and shifts the fetch of the fragment density map by that amount. Offsets can be positive or negative.

Offset values specified for any subpass that is not the last subpass in the render pass are ignored. If the VkSubpassEndInfo::pNext chain for the last subpass of a render pass does not include VkSubpassFragmentDensityMapOffsetEndInfoQCOM, or if fragmentDensityOffsetCount is zero, then the offset (0,0) is used for Fetch Density Value.

Valid Usage

• If the fragmentDensityMapOffset feature is not enabled or fragment density map is not enabled in the render pass, fragmentDensityOffsetCount must equal 0
• If VkSubpassDescription::fragmentDensityMapAttachment is not is not ATTACHMENT_UNUSED and was not created with IMAGE_CREATE_FRAGMENT_DENSITY_MAP_OFFSET_BIT_QCOM, fragmentDensityOffsetCount must equal 0
• If VkSubpassDescription::pDepthStencilAttachment is not is not ATTACHMENT_UNUSED and was not created with IMAGE_CREATE_FRAGMENT_DENSITY_MAP_OFFSET_BIT_QCOM, fragmentDensityOffsetCount must equal 0
• If any element of VkSubpassDescription::pInputAttachments is not is not ATTACHMENT_UNUSED and was not created with IMAGE_CREATE_FRAGMENT_DENSITY_MAP_OFFSET_BIT_QCOM, fragmentDensityOffsetCount must equal 0
• If any element of VkSubpassDescription::pColorAttachments is not is not ATTACHMENT_UNUSED and was not created with IMAGE_CREATE_FRAGMENT_DENSITY_MAP_OFFSET_BIT_QCOM, fragmentDensityOffsetCount must equal 0
• If any element of VkSubpassDescription::pResolveAttachments is not is not ATTACHMENT_UNUSED and was not created with IMAGE_CREATE_FRAGMENT_DENSITY_MAP_OFFSET_BIT_QCOM, fragmentDensityOffsetCount must equal 0
• If any element of VkSubpassDescription::pPreserveAttachments is not is not ATTACHMENT_UNUSED and was not created with IMAGE_CREATE_FRAGMENT_DENSITY_MAP_OFFSET_BIT_QCOM, fragmentDensityOffsetCount must equal 0
• If fragmentDensityOffsetCount is not 0 and multiview is enabled for the render pass, fragmentDensityOffsetCount must equal the layerCount that was specified in creating the fragment density map attachment view
• If fragmentDensityOffsetCount is not 0 and multiview is not enabled for the render pass, fragmentDensityOffsetCount must equal 1
• The x component of each element of pFragmentDensityOffsets must be an integer multiple of fragmentDensityOffsetGranularity.width
• The y component of each element of pFragmentDensityOffsets must be an integer multiple of fragmentDensityOffsetGranularity.height

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SUBPASS_FRAGMENT_DENSITY_MAP_OFFSET_END_INFO_QCOM
• If fragmentDensityOffsetCount is not 0, pFragmentDensityOffsets must be a valid pointer to an array of fragmentDensityOffsetCount VkOffset2D structures

See Also

VkOffset2D

Layout

 struct VkSubpassFragmentDensityMapOffsetEndInfoQCOM {
     VkStructureType sType();
     void const * pNext();
     uint32_t fragmentDensityOffsetCount();
     VkOffset2D const * pFragmentDensityOffsets();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkSubpassFragmentDensityMapOffsetEndInfoQCOM	calloc()	Returns a new VkSubpassFragmentDensityMapOffsetEndInfoQCOM instance allocated with memCalloc.
static VkSubpassFragmentDensityMapOffsetEndInfoQCOM.Buffer	calloc(int capacity)	Returns a new VkSubpassFragmentDensityMapOffsetEndInfoQCOM.Buffer instance allocated with memCalloc.
static VkSubpassFragmentDensityMapOffsetEndInfoQCOM.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkSubpassFragmentDensityMapOffsetEndInfoQCOM.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSubpassFragmentDensityMapOffsetEndInfoQCOM	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkSubpassFragmentDensityMapOffsetEndInfoQCOM instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSubpassFragmentDensityMapOffsetEndInfoQCOM	create()	Returns a new VkSubpassFragmentDensityMapOffsetEndInfoQCOM instance allocated with BufferUtils.
static VkSubpassFragmentDensityMapOffsetEndInfoQCOM.Buffer	create(int capacity)	Returns a new VkSubpassFragmentDensityMapOffsetEndInfoQCOM.Buffer instance allocated with BufferUtils.
static VkSubpassFragmentDensityMapOffsetEndInfoQCOM	create(long address)	Returns a new VkSubpassFragmentDensityMapOffsetEndInfoQCOM instance for the specified memory address.
static VkSubpassFragmentDensityMapOffsetEndInfoQCOM.Buffer	create(long address, int capacity)	Create a VkSubpassFragmentDensityMapOffsetEndInfoQCOM.Buffer instance at the specified memory.
static @Nullable VkSubpassFragmentDensityMapOffsetEndInfoQCOM	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkSubpassFragmentDensityMapOffsetEndInfoQCOM.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	fragmentDensityOffsetCount()	the number of offsets being specified.
static VkSubpassFragmentDensityMapOffsetEndInfoQCOM	malloc()	Returns a new VkSubpassFragmentDensityMapOffsetEndInfoQCOM instance allocated with memAlloc.
static VkSubpassFragmentDensityMapOffsetEndInfoQCOM.Buffer	malloc(int capacity)	Returns a new VkSubpassFragmentDensityMapOffsetEndInfoQCOM.Buffer instance allocated with memAlloc.
static VkSubpassFragmentDensityMapOffsetEndInfoQCOM.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkSubpassFragmentDensityMapOffsetEndInfoQCOM.Buffer instance allocated on the specified MemoryStack.
static VkSubpassFragmentDensityMapOffsetEndInfoQCOM	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkSubpassFragmentDensityMapOffsetEndInfoQCOM instance allocated on the specified MemoryStack.
static int	nfragmentDensityOffsetCount(long struct)	Unsafe version of fragmentDensityOffsetCount().
static void	nfragmentDensityOffsetCount(long struct, int value)	Sets the specified value to the fragmentDensityOffsetCount field of the specified struct.
static @Nullable VkOffset2D.Buffer	npFragmentDensityOffsets(long struct)	Unsafe version of pFragmentDensityOffsets().
static void	npFragmentDensityOffsets(long struct, @Nullable VkOffset2D.Buffer value)	Unsafe version of pFragmentDensityOffsets.
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.
@Nullable VkOffset2D.Buffer	pFragmentDensityOffsets()	a pointer to an array of VkOffset2D structs, each of which describes the offset per layer.
VkSubpassFragmentDensityMapOffsetEndInfoQCOM	pFragmentDensityOffsets(@Nullable VkOffset2D.Buffer value)	Sets the address of the specified VkOffset2D.Buffer to the pFragmentDensityOffsets() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkSubpassFragmentDensityMapOffsetEndInfoQCOM	pNext(long value)	Sets the specified value to the pNext() field.
VkSubpassFragmentDensityMapOffsetEndInfoQCOM	set(int sType, long pNext, @Nullable VkOffset2D.Buffer pFragmentDensityOffsets)	Initializes this struct with the specified values.
VkSubpassFragmentDensityMapOffsetEndInfoQCOM	set(VkSubpassFragmentDensityMapOffsetEndInfoQCOM src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkSubpassFragmentDensityMapOffsetEndInfoQCOM	sType(int value)	Sets the specified value to the sType() field.
VkSubpassFragmentDensityMapOffsetEndInfoQCOM	sType$Default()	Sets the STRUCTURE_TYPE_SUBPASS_FRAGMENT_DENSITY_MAP_OFFSET_END_INFO_QCOM value to the sType() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

FRAGMENTDENSITYOFFSETCOUNT

public static final int FRAGMENTDENSITYOFFSETCOUNT

The struct member offsets.

PFRAGMENTDENSITYOFFSETS

public static final int PFRAGMENTDENSITYOFFSETS

The struct member offsets.

Constructor Details

VkSubpassFragmentDensityMapOffsetEndInfoQCOM

public VkSubpassFragmentDensityMapOffsetEndInfoQCOM(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

fragmentDensityOffsetCount

public int fragmentDensityOffsetCount()

the number of offsets being specified.

pFragmentDensityOffsets

public @Nullable VkOffset2D.Buffer pFragmentDensityOffsets()

a pointer to an array of VkOffset2D structs, each of which describes the offset per layer.

sType

public VkSubpassFragmentDensityMapOffsetEndInfoQCOM sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkSubpassFragmentDensityMapOffsetEndInfoQCOM sType$Default()

Sets the STRUCTURE_TYPE_SUBPASS_FRAGMENT_DENSITY_MAP_OFFSET_END_INFO_QCOM value to the sType() field.

pNext

public VkSubpassFragmentDensityMapOffsetEndInfoQCOM pNext(long value)

Sets the specified value to the pNext() field.

pFragmentDensityOffsets

public VkSubpassFragmentDensityMapOffsetEndInfoQCOM pFragmentDensityOffsets(@Nullable VkOffset2D.Buffer value)

Sets the address of the specified VkOffset2D.Buffer to the pFragmentDensityOffsets() field.

set

public VkSubpassFragmentDensityMapOffsetEndInfoQCOM set(int sType,
 long pNext,
 @Nullable VkOffset2D.Buffer pFragmentDensityOffsets)

Initializes this struct with the specified values.

set

public VkSubpassFragmentDensityMapOffsetEndInfoQCOM set(VkSubpassFragmentDensityMapOffsetEndInfoQCOM src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkSubpassFragmentDensityMapOffsetEndInfoQCOM malloc()

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

calloc

public static VkSubpassFragmentDensityMapOffsetEndInfoQCOM calloc()

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

create

public static VkSubpassFragmentDensityMapOffsetEndInfoQCOM create()

Returns a new VkSubpassFragmentDensityMapOffsetEndInfoQCOM instance allocated with BufferUtils.

create

public static VkSubpassFragmentDensityMapOffsetEndInfoQCOM create(long address)

Returns a new VkSubpassFragmentDensityMapOffsetEndInfoQCOM instance for the specified memory address.

createSafe

public static @Nullable VkSubpassFragmentDensityMapOffsetEndInfoQCOM createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkSubpassFragmentDensityMapOffsetEndInfoQCOM.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkSubpassFragmentDensityMapOffsetEndInfoQCOM.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkSubpassFragmentDensityMapOffsetEndInfoQCOM.Buffer create(int capacity)

Returns a new VkSubpassFragmentDensityMapOffsetEndInfoQCOM.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkSubpassFragmentDensityMapOffsetEndInfoQCOM.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkSubpassFragmentDensityMapOffsetEndInfoQCOM instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nfragmentDensityOffsetCount

public static int nfragmentDensityOffsetCount(long struct)

Unsafe version of fragmentDensityOffsetCount().

npFragmentDensityOffsets

public static @Nullable VkOffset2D.Buffer npFragmentDensityOffsets(long struct)

Unsafe version of pFragmentDensityOffsets().

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.

nfragmentDensityOffsetCount

public static void nfragmentDensityOffsetCount(long struct,
 int value)

Sets the specified value to the fragmentDensityOffsetCount field of the specified struct.

npFragmentDensityOffsets

public static void npFragmentDensityOffsets(long struct,
 @Nullable VkOffset2D.Buffer value)

Unsafe version of pFragmentDensityOffsets.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate