Package org.lwjgl.vulkan

Class VkRenderingFragmentDensityMapAttachmentInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkRenderingFragmentDensityMapAttachmentInfoEXT>

org.lwjgl.vulkan.VkRenderingFragmentDensityMapAttachmentInfoEXT

All Implemented Interfaces:

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

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

Structure specifying fragment shading rate attachment information.

Description

This structure can be included in the pNext chain of VkRenderingInfo to define a fragment density map. If this structure is not included in the pNext chain, imageView is treated as NULL_HANDLE.

Valid Usage

• If imageView is not NULL_HANDLE, imageLayout must be IMAGE_LAYOUT_GENERAL or IMAGE_LAYOUT_FRAGMENT_DENSITY_MAP_OPTIMAL_EXT
• If imageView is not NULL_HANDLE, it must have been created with IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT
• If imageView is not NULL_HANDLE, it must not have been created with IMAGE_CREATE_SUBSAMPLED_BIT_EXT
• If the multiview feature is not enabled, VkPhysicalDeviceProperties::apiVersion is less than Vulkan 1.1, and imageView is not NULL_HANDLE, it must have a layerCount equal to 1

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RENDERING_FRAGMENT_DENSITY_MAP_ATTACHMENT_INFO_EXT
• imageView must be a valid VkImageView handle
• imageLayout must be a valid VkImageLayout value

Layout

 struct VkRenderingFragmentDensityMapAttachmentInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkImageView imageView();
     VkImageLayout imageLayout();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkRenderingFragmentDensityMapAttachmentInfoEXT	calloc()	Returns a new VkRenderingFragmentDensityMapAttachmentInfoEXT instance allocated with memCalloc.
static VkRenderingFragmentDensityMapAttachmentInfoEXT.Buffer	calloc(int capacity)	Returns a new VkRenderingFragmentDensityMapAttachmentInfoEXT.Buffer instance allocated with memCalloc.
static VkRenderingFragmentDensityMapAttachmentInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderingFragmentDensityMapAttachmentInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkRenderingFragmentDensityMapAttachmentInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderingFragmentDensityMapAttachmentInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkRenderingFragmentDensityMapAttachmentInfoEXT	create()	Returns a new VkRenderingFragmentDensityMapAttachmentInfoEXT instance allocated with BufferUtils.
static VkRenderingFragmentDensityMapAttachmentInfoEXT.Buffer	create(int capacity)	Returns a new VkRenderingFragmentDensityMapAttachmentInfoEXT.Buffer instance allocated with BufferUtils.
static VkRenderingFragmentDensityMapAttachmentInfoEXT	create(long address)	Returns a new VkRenderingFragmentDensityMapAttachmentInfoEXT instance for the specified memory address.
static VkRenderingFragmentDensityMapAttachmentInfoEXT.Buffer	create(long address, int capacity)	Create a VkRenderingFragmentDensityMapAttachmentInfoEXT.Buffer instance at the specified memory.
static @Nullable VkRenderingFragmentDensityMapAttachmentInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkRenderingFragmentDensityMapAttachmentInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	imageLayout()	the layout that imageView will be in during rendering.
VkRenderingFragmentDensityMapAttachmentInfoEXT	imageLayout(int value)	Sets the specified value to the imageLayout() field.
long	imageView()	the image view that will be used as a fragment density map attachment.
VkRenderingFragmentDensityMapAttachmentInfoEXT	imageView(long value)	Sets the specified value to the imageView() field.
static VkRenderingFragmentDensityMapAttachmentInfoEXT	malloc()	Returns a new VkRenderingFragmentDensityMapAttachmentInfoEXT instance allocated with memAlloc.
static VkRenderingFragmentDensityMapAttachmentInfoEXT.Buffer	malloc(int capacity)	Returns a new VkRenderingFragmentDensityMapAttachmentInfoEXT.Buffer instance allocated with memAlloc.
static VkRenderingFragmentDensityMapAttachmentInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderingFragmentDensityMapAttachmentInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkRenderingFragmentDensityMapAttachmentInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderingFragmentDensityMapAttachmentInfoEXT instance allocated on the specified MemoryStack.
static int	nimageLayout(long struct)	Unsafe version of imageLayout().
static void	nimageLayout(long struct, int value)	Unsafe version of imageLayout.
static long	nimageView(long struct)	Unsafe version of imageView().
static void	nimageView(long struct, long value)	Unsafe version of imageView.
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.
VkRenderingFragmentDensityMapAttachmentInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkRenderingFragmentDensityMapAttachmentInfoEXT	set(int sType, long pNext, long imageView, int imageLayout)	Initializes this struct with the specified values.
VkRenderingFragmentDensityMapAttachmentInfoEXT	set(VkRenderingFragmentDensityMapAttachmentInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkRenderingFragmentDensityMapAttachmentInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkRenderingFragmentDensityMapAttachmentInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_RENDERING_FRAGMENT_DENSITY_MAP_ATTACHMENT_INFO_EXT 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.

IMAGEVIEW

public static final int IMAGEVIEW

The struct member offsets.

IMAGELAYOUT

public static final int IMAGELAYOUT

The struct member offsets.

Constructor Details

VkRenderingFragmentDensityMapAttachmentInfoEXT

public VkRenderingFragmentDensityMapAttachmentInfoEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

imageView

public long imageView()

the image view that will be used as a fragment density map attachment.

imageLayout

public int imageLayout()

the layout that imageView will be in during rendering.

sType

public VkRenderingFragmentDensityMapAttachmentInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkRenderingFragmentDensityMapAttachmentInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_RENDERING_FRAGMENT_DENSITY_MAP_ATTACHMENT_INFO_EXT value to the sType() field.

pNext

public VkRenderingFragmentDensityMapAttachmentInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

imageView

public VkRenderingFragmentDensityMapAttachmentInfoEXT imageView(long value)

Sets the specified value to the imageView() field.

imageLayout

public VkRenderingFragmentDensityMapAttachmentInfoEXT imageLayout(int value)

Sets the specified value to the imageLayout() field.

set

public VkRenderingFragmentDensityMapAttachmentInfoEXT set(int sType,
 long pNext,
 long imageView,
 int imageLayout)

Initializes this struct with the specified values.

set

public VkRenderingFragmentDensityMapAttachmentInfoEXT set(VkRenderingFragmentDensityMapAttachmentInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkRenderingFragmentDensityMapAttachmentInfoEXT malloc()

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

calloc

public static VkRenderingFragmentDensityMapAttachmentInfoEXT calloc()

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

create

public static VkRenderingFragmentDensityMapAttachmentInfoEXT create()

Returns a new VkRenderingFragmentDensityMapAttachmentInfoEXT instance allocated with BufferUtils.

create

public static VkRenderingFragmentDensityMapAttachmentInfoEXT create(long address)

Returns a new VkRenderingFragmentDensityMapAttachmentInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkRenderingFragmentDensityMapAttachmentInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkRenderingFragmentDensityMapAttachmentInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkRenderingFragmentDensityMapAttachmentInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkRenderingFragmentDensityMapAttachmentInfoEXT.Buffer create(int capacity)

Returns a new VkRenderingFragmentDensityMapAttachmentInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkRenderingFragmentDensityMapAttachmentInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkRenderingFragmentDensityMapAttachmentInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nimageView

public static long nimageView(long struct)

Unsafe version of imageView().

nimageLayout

public static int nimageLayout(long struct)

Unsafe version of imageLayout().

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.

nimageView

public static void nimageView(long struct,
 long value)

Unsafe version of imageView.

nimageLayout

public static void nimageLayout(long struct,
 int value)

Unsafe version of imageLayout.