Package org.lwjgl.vulkan

Class VkAttachmentSampleCountInfoAMD

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkAttachmentSampleCountInfoAMD>

org.lwjgl.vulkan.VkAttachmentSampleCountInfoAMD

All Implemented Interfaces:

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

Direct Known Subclasses:

VkAttachmentSampleCountInfoNV

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

Structure specifying command buffer inheritance info for dynamic render pass instances.

Description

If VkCommandBufferInheritanceInfo::renderPass is NULL_HANDLE, COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT is specified in VkCommandBufferBeginInfo::flags, and the pNext chain of VkCommandBufferInheritanceInfo includes VkAttachmentSampleCountInfoAMD, then this structure defines the sample counts of each attachment within the render pass instance. If VkAttachmentSampleCountInfoAMD is not included, the value of VkCommandBufferInheritanceRenderingInfo::rasterizationSamples is used as the sample count for each attachment. If VkCommandBufferInheritanceInfo::renderPass is not NULL_HANDLE, or COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT is not specified in VkCommandBufferBeginInfo::flags, parameters of this structure are ignored.

VkAttachmentSampleCountInfoAMD can also be included in the pNext chain of VkGraphicsPipelineCreateInfo. When a graphics pipeline is created without a VkRenderPass, if this structure is included in the pNext chain of VkGraphicsPipelineCreateInfo, it specifies the sample count of attachments used for rendering. If this structure is not specified, and the pipeline does not include a VkRenderPass, the value of VkPipelineMultisampleStateCreateInfo::rasterizationSamples is used as the sample count for each attachment. If a graphics pipeline is created with a valid VkRenderPass, parameters of this structure are ignored.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_ATTACHMENT_SAMPLE_COUNT_INFO_AMD

Layout

 struct VkAttachmentSampleCountInfoAMD {
     VkStructureType sType();
     void const * pNext();
     uint32_t colorAttachmentCount();
     VkSampleCountFlagBits const * pColorAttachmentSamples();
     VkSampleCountFlagBits depthStencilAttachmentSamples();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkAttachmentSampleCountInfoAMD	calloc()	Returns a new VkAttachmentSampleCountInfoAMD instance allocated with memCalloc.
static VkAttachmentSampleCountInfoAMD.Buffer	calloc(int capacity)	Returns a new VkAttachmentSampleCountInfoAMD.Buffer instance allocated with memCalloc.
static VkAttachmentSampleCountInfoAMD.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAttachmentSampleCountInfoAMD.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAttachmentSampleCountInfoAMD	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAttachmentSampleCountInfoAMD instance allocated on the specified MemoryStack and initializes all its bits to zero.
int	colorAttachmentCount()	the number of color attachments specified in a render pass instance.
VkAttachmentSampleCountInfoAMD	colorAttachmentCount(int value)	Sets the specified value to the colorAttachmentCount() field.
static VkAttachmentSampleCountInfoAMD	create()	Returns a new VkAttachmentSampleCountInfoAMD instance allocated with BufferUtils.
static VkAttachmentSampleCountInfoAMD.Buffer	create(int capacity)	Returns a new VkAttachmentSampleCountInfoAMD.Buffer instance allocated with BufferUtils.
static VkAttachmentSampleCountInfoAMD	create(long address)	Returns a new VkAttachmentSampleCountInfoAMD instance for the specified memory address.
static VkAttachmentSampleCountInfoAMD.Buffer	create(long address, int capacity)	Create a VkAttachmentSampleCountInfoAMD.Buffer instance at the specified memory.
static @Nullable VkAttachmentSampleCountInfoAMD	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkAttachmentSampleCountInfoAMD.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	depthStencilAttachmentSamples()	a VkSampleCountFlagBits value defining the sample count of a depth/stencil attachment.
VkAttachmentSampleCountInfoAMD	depthStencilAttachmentSamples(int value)	Sets the specified value to the depthStencilAttachmentSamples() field.
static VkAttachmentSampleCountInfoAMD	malloc()	Returns a new VkAttachmentSampleCountInfoAMD instance allocated with memAlloc.
static VkAttachmentSampleCountInfoAMD.Buffer	malloc(int capacity)	Returns a new VkAttachmentSampleCountInfoAMD.Buffer instance allocated with memAlloc.
static VkAttachmentSampleCountInfoAMD.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAttachmentSampleCountInfoAMD.Buffer instance allocated on the specified MemoryStack.
static VkAttachmentSampleCountInfoAMD	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAttachmentSampleCountInfoAMD instance allocated on the specified MemoryStack.
static int	ncolorAttachmentCount(long struct)	Unsafe version of colorAttachmentCount().
static void	ncolorAttachmentCount(long struct, int value)	Sets the specified value to the colorAttachmentCount field of the specified struct.
static int	ndepthStencilAttachmentSamples(long struct)	Unsafe version of depthStencilAttachmentSamples().
static void	ndepthStencilAttachmentSamples(long struct, int value)	Unsafe version of depthStencilAttachmentSamples.
static @Nullable IntBuffer	npColorAttachmentSamples(long struct)	Unsafe version of pColorAttachmentSamples.
static void	npColorAttachmentSamples(long struct, @Nullable IntBuffer value)	Unsafe version of pColorAttachmentSamples.
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 IntBuffer	pColorAttachmentSamples()	a pointer to an array of VkSampleCountFlagBits values defining the sample count of color attachments.
VkAttachmentSampleCountInfoAMD	pColorAttachmentSamples(@Nullable IntBuffer value)	Sets the address of the specified IntBuffer to the pColorAttachmentSamples() field.
long	pNext()	NULL or a pointer to a structure extending this structure
VkAttachmentSampleCountInfoAMD	pNext(long value)	Sets the specified value to the pNext() field.
VkAttachmentSampleCountInfoAMD	set(int sType, long pNext, int colorAttachmentCount, @Nullable IntBuffer pColorAttachmentSamples, int depthStencilAttachmentSamples)	Initializes this struct with the specified values.
VkAttachmentSampleCountInfoAMD	set(VkAttachmentSampleCountInfoAMD src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkAttachmentSampleCountInfoAMD	sType(int value)	Sets the specified value to the sType() field.
VkAttachmentSampleCountInfoAMD	sType$Default()	Sets the STRUCTURE_TYPE_ATTACHMENT_SAMPLE_COUNT_INFO_AMD 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.

COLORATTACHMENTCOUNT

public static final int COLORATTACHMENTCOUNT

The struct member offsets.

PCOLORATTACHMENTSAMPLES

public static final int PCOLORATTACHMENTSAMPLES

The struct member offsets.

DEPTHSTENCILATTACHMENTSAMPLES

public static final int DEPTHSTENCILATTACHMENTSAMPLES

The struct member offsets.

Constructor Details

VkAttachmentSampleCountInfoAMD

public VkAttachmentSampleCountInfoAMD(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure

colorAttachmentCount

public int colorAttachmentCount()

the number of color attachments specified in a render pass instance.

pColorAttachmentSamples

public @Nullable IntBuffer pColorAttachmentSamples()

a pointer to an array of VkSampleCountFlagBits values defining the sample count of color attachments.

depthStencilAttachmentSamples

public int depthStencilAttachmentSamples()

a VkSampleCountFlagBits value defining the sample count of a depth/stencil attachment.

sType

public VkAttachmentSampleCountInfoAMD sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkAttachmentSampleCountInfoAMD sType$Default()

Sets the STRUCTURE_TYPE_ATTACHMENT_SAMPLE_COUNT_INFO_AMD value to the sType() field.

pNext

public VkAttachmentSampleCountInfoAMD pNext(long value)

Sets the specified value to the pNext() field.

colorAttachmentCount

public VkAttachmentSampleCountInfoAMD colorAttachmentCount(int value)

Sets the specified value to the colorAttachmentCount() field.

pColorAttachmentSamples

public VkAttachmentSampleCountInfoAMD pColorAttachmentSamples(@Nullable IntBuffer value)

Sets the address of the specified IntBuffer to the pColorAttachmentSamples() field.

depthStencilAttachmentSamples

public VkAttachmentSampleCountInfoAMD depthStencilAttachmentSamples(int value)

Sets the specified value to the depthStencilAttachmentSamples() field.

set

public VkAttachmentSampleCountInfoAMD set(int sType,
 long pNext,
 int colorAttachmentCount,
 @Nullable IntBuffer pColorAttachmentSamples,
 int depthStencilAttachmentSamples)

Initializes this struct with the specified values.

set

public VkAttachmentSampleCountInfoAMD set(VkAttachmentSampleCountInfoAMD src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkAttachmentSampleCountInfoAMD malloc()

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

calloc

public static VkAttachmentSampleCountInfoAMD calloc()

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

create

public static VkAttachmentSampleCountInfoAMD create()

Returns a new VkAttachmentSampleCountInfoAMD instance allocated with BufferUtils.

create

public static VkAttachmentSampleCountInfoAMD create(long address)

Returns a new VkAttachmentSampleCountInfoAMD instance for the specified memory address.

createSafe

public static @Nullable VkAttachmentSampleCountInfoAMD createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkAttachmentSampleCountInfoAMD.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkAttachmentSampleCountInfoAMD.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkAttachmentSampleCountInfoAMD.Buffer create(int capacity)

Returns a new VkAttachmentSampleCountInfoAMD.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkAttachmentSampleCountInfoAMD.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkAttachmentSampleCountInfoAMD instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ncolorAttachmentCount

public static int ncolorAttachmentCount(long struct)

Unsafe version of colorAttachmentCount().

npColorAttachmentSamples

public static @Nullable IntBuffer npColorAttachmentSamples(long struct)

Unsafe version of pColorAttachmentSamples.

ndepthStencilAttachmentSamples

public static int ndepthStencilAttachmentSamples(long struct)

Unsafe version of depthStencilAttachmentSamples().

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.

ncolorAttachmentCount

public static void ncolorAttachmentCount(long struct,
 int value)

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

npColorAttachmentSamples

public static void npColorAttachmentSamples(long struct,
 @Nullable IntBuffer value)

Unsafe version of pColorAttachmentSamples.

ndepthStencilAttachmentSamples

public static void ndepthStencilAttachmentSamples(long struct,
 int value)

Unsafe version of depthStencilAttachmentSamples.