Package org.lwjgl.vulkan

Class VkRenderPassFragmentDensityMapCreateInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkRenderPassFragmentDensityMapCreateInfoEXT>

org.lwjgl.vulkan.VkRenderPassFragmentDensityMapCreateInfoEXT

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkRenderPassFragmentDensityMapCreateInfoEXT
extends Struct<VkRenderPassFragmentDensityMapCreateInfoEXT>
implements NativeResource

Structure containing fragment density map attachment for render pass.

Description

The fragment density map is read at an implementation-dependent time with the following constraints determined by the attachment’s image view flags:

• IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT specifies that the fragment density map will be read by the device during PIPELINE_STAGE_FRAGMENT_DENSITY_PROCESS_BIT_EXT
• IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT specifies that the fragment density map will be read by the host during EndCommandBuffer of the primary command buffer that the render pass is recorded into
• Otherwise the fragment density map will be read by the host during CmdBeginRenderPass

The fragment density map may additionally be read by the device during PIPELINE_STAGE_FRAGMENT_DENSITY_PROCESS_BIT_EXT for any mode.

If this structure is not present, it is as if fragmentDensityMapAttachment was given as ATTACHMENT_UNUSED.

Valid Usage

• If fragmentDensityMapAttachment is not ATTACHMENT_UNUSED, fragmentDensityMapAttachment must not be an element of VkSubpassDescription::pInputAttachments, VkSubpassDescription::pColorAttachments, VkSubpassDescription::pResolveAttachments, VkSubpassDescription::pDepthStencilAttachment, or VkSubpassDescription::pPreserveAttachments for any subpass
• If fragmentDensityMapAttachment is not ATTACHMENT_UNUSED, layout must be equal to IMAGE_LAYOUT_FRAGMENT_DENSITY_MAP_OPTIMAL_EXT, or IMAGE_LAYOUT_GENERAL
• If fragmentDensityMapAttachment is not ATTACHMENT_UNUSED, fragmentDensityMapAttachment must reference an attachment with a loadOp equal to ATTACHMENT_LOAD_OP_LOAD or ATTACHMENT_LOAD_OP_DONT_CARE
• If fragmentDensityMapAttachment is not ATTACHMENT_UNUSED, fragmentDensityMapAttachment must reference an attachment with a storeOp equal to ATTACHMENT_STORE_OP_DONT_CARE

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RENDER_PASS_FRAGMENT_DENSITY_MAP_CREATE_INFO_EXT
• fragmentDensityMapAttachment must be a valid VkAttachmentReference structure

See Also

VkAttachmentReference

Layout

 struct VkRenderPassFragmentDensityMapCreateInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkAttachmentReference fragmentDensityMapAttachment();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer	An array of VkRenderPassFragmentDensityMapCreateInfoEXT structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	FRAGMENTDENSITYMAPATTACHMENT	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
VkRenderPassFragmentDensityMapCreateInfoEXT(ByteBuffer container)	Creates a VkRenderPassFragmentDensityMapCreateInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkRenderPassFragmentDensityMapCreateInfoEXT	calloc()	Returns a new VkRenderPassFragmentDensityMapCreateInfoEXT instance allocated with memCalloc.
static VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer	calloc(int capacity)	Returns a new VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer instance allocated with memCalloc.
static VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkRenderPassFragmentDensityMapCreateInfoEXT	calloc(MemoryStack stack)	Returns a new VkRenderPassFragmentDensityMapCreateInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkRenderPassFragmentDensityMapCreateInfoEXT	callocStack()	Deprecated.
static VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer	callocStack(int capacity)	Deprecated.
static VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkRenderPassFragmentDensityMapCreateInfoEXT	callocStack(MemoryStack stack)	Deprecated.
static VkRenderPassFragmentDensityMapCreateInfoEXT	create()	Returns a new VkRenderPassFragmentDensityMapCreateInfoEXT instance allocated with BufferUtils.
static VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer	create(int capacity)	Returns a new VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer instance allocated with BufferUtils.
static VkRenderPassFragmentDensityMapCreateInfoEXT	create(long address)	Returns a new VkRenderPassFragmentDensityMapCreateInfoEXT instance for the specified memory address.
static VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer	create(long address, int capacity)	Create a VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer instance at the specified memory.
static VkRenderPassFragmentDensityMapCreateInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkAttachmentReference	fragmentDensityMapAttachment()	the fragment density map to use for the render pass.
VkRenderPassFragmentDensityMapCreateInfoEXT	fragmentDensityMapAttachment(Consumer<VkAttachmentReference> consumer)	Passes the fragmentDensityMapAttachment() field to the specified Consumer.
VkRenderPassFragmentDensityMapCreateInfoEXT	fragmentDensityMapAttachment(VkAttachmentReference value)	Copies the specified VkAttachmentReference to the fragmentDensityMapAttachment() field.
static VkRenderPassFragmentDensityMapCreateInfoEXT	malloc()	Returns a new VkRenderPassFragmentDensityMapCreateInfoEXT instance allocated with memAlloc.
static VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer	malloc(int capacity)	Returns a new VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer instance allocated with memAlloc.
static VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkRenderPassFragmentDensityMapCreateInfoEXT	malloc(MemoryStack stack)	Returns a new VkRenderPassFragmentDensityMapCreateInfoEXT instance allocated on the specified MemoryStack.
static VkRenderPassFragmentDensityMapCreateInfoEXT	mallocStack()	Deprecated.
static VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer	mallocStack(int capacity)	Deprecated.
static VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkRenderPassFragmentDensityMapCreateInfoEXT	mallocStack(MemoryStack stack)	Deprecated.
static VkAttachmentReference	nfragmentDensityMapAttachment(long struct)	Unsafe version of fragmentDensityMapAttachment().
static void	nfragmentDensityMapAttachment(long struct, VkAttachmentReference value)	Unsafe version of fragmentDensityMapAttachment.
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.
VkRenderPassFragmentDensityMapCreateInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkRenderPassFragmentDensityMapCreateInfoEXT	set(int sType, long pNext, VkAttachmentReference fragmentDensityMapAttachment)	Initializes this struct with the specified values.
VkRenderPassFragmentDensityMapCreateInfoEXT	set(VkRenderPassFragmentDensityMapCreateInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()	a VkStructureType value identifying this structure.
VkRenderPassFragmentDensityMapCreateInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkRenderPassFragmentDensityMapCreateInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_RENDER_PASS_FRAGMENT_DENSITY_MAP_CREATE_INFO_EXT value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, 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.

FRAGMENTDENSITYMAPATTACHMENT

public static final int FRAGMENTDENSITYMAPATTACHMENT

The struct member offsets.

Constructor Details

VkRenderPassFragmentDensityMapCreateInfoEXT

public VkRenderPassFragmentDensityMapCreateInfoEXT(ByteBuffer container)

Creates a VkRenderPassFragmentDensityMapCreateInfoEXT 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()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkRenderPassFragmentDensityMapCreateInfoEXT>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

fragmentDensityMapAttachment

public VkAttachmentReference fragmentDensityMapAttachment()

the fragment density map to use for the render pass.

sType

public VkRenderPassFragmentDensityMapCreateInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkRenderPassFragmentDensityMapCreateInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_RENDER_PASS_FRAGMENT_DENSITY_MAP_CREATE_INFO_EXT value to the sType() field.

pNext

public VkRenderPassFragmentDensityMapCreateInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

fragmentDensityMapAttachment

public VkRenderPassFragmentDensityMapCreateInfoEXT fragmentDensityMapAttachment(VkAttachmentReference value)

Copies the specified VkAttachmentReference to the fragmentDensityMapAttachment() field.

fragmentDensityMapAttachment

public VkRenderPassFragmentDensityMapCreateInfoEXT fragmentDensityMapAttachment(Consumer<VkAttachmentReference> consumer)

Passes the fragmentDensityMapAttachment() field to the specified Consumer.

set

public VkRenderPassFragmentDensityMapCreateInfoEXT set(int sType,
 long pNext,
 VkAttachmentReference fragmentDensityMapAttachment)

Initializes this struct with the specified values.

set

public VkRenderPassFragmentDensityMapCreateInfoEXT set(VkRenderPassFragmentDensityMapCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkRenderPassFragmentDensityMapCreateInfoEXT malloc()

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

calloc

public static VkRenderPassFragmentDensityMapCreateInfoEXT calloc()

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

create

public static VkRenderPassFragmentDensityMapCreateInfoEXT create()

Returns a new VkRenderPassFragmentDensityMapCreateInfoEXT instance allocated with BufferUtils.

create

public static VkRenderPassFragmentDensityMapCreateInfoEXT create(long address)

Returns a new VkRenderPassFragmentDensityMapCreateInfoEXT instance for the specified memory address.

createSafe

@Nullable
public static VkRenderPassFragmentDensityMapCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer create(int capacity)

Returns a new VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkRenderPassFragmentDensityMapCreateInfoEXT mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkRenderPassFragmentDensityMapCreateInfoEXT callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkRenderPassFragmentDensityMapCreateInfoEXT mallocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkRenderPassFragmentDensityMapCreateInfoEXT callocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static VkRenderPassFragmentDensityMapCreateInfoEXT malloc(MemoryStack stack)

Returns a new VkRenderPassFragmentDensityMapCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkRenderPassFragmentDensityMapCreateInfoEXT calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkRenderPassFragmentDensityMapCreateInfoEXT.Buffer calloc(int capacity,
 MemoryStack stack)

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

nfragmentDensityMapAttachment

public static VkAttachmentReference nfragmentDensityMapAttachment(long struct)

Unsafe version of fragmentDensityMapAttachment().

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.

nfragmentDensityMapAttachment

public static void nfragmentDensityMapAttachment(long struct,
 VkAttachmentReference value)

Unsafe version of fragmentDensityMapAttachment.