Package org.lwjgl.vulkan

Class VkAttachmentSampleLocationsEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkAttachmentSampleLocationsEXT>

org.lwjgl.vulkan.VkAttachmentSampleLocationsEXT

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkAttachmentSampleLocationsEXT
extends Struct<VkAttachmentSampleLocationsEXT>
implements NativeResource

Structure specifying the sample locations state to use in the initial layout transition of attachments.

Description

If the image referenced by the framebuffer attachment at index attachmentIndex was not created with IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT then the values specified in sampleLocationsInfo are ignored.

Valid Usage

• attachmentIndex must be less than the attachmentCount specified in VkRenderPassCreateInfo the render pass specified by VkRenderPassBeginInfo::renderPass was created with

Valid Usage (Implicit)

• sampleLocationsInfo must be a valid VkSampleLocationsInfoEXT structure

See Also

VkRenderPassSampleLocationsBeginInfoEXT, VkSampleLocationsInfoEXT

Layout

 struct VkAttachmentSampleLocationsEXT {
     uint32_t attachmentIndex();
     VkSampleLocationsInfoEXT sampleLocationsInfo();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkAttachmentSampleLocationsEXT.Buffer	An array of VkAttachmentSampleLocationsEXT 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	ATTACHMENTINDEX	The struct member offsets.
static final int	SAMPLELOCATIONSINFO	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkAttachmentSampleLocationsEXT(ByteBuffer container)	Creates a VkAttachmentSampleLocationsEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
int	attachmentIndex()	the index of the attachment for which the sample locations state is provided.
VkAttachmentSampleLocationsEXT	attachmentIndex(int value)	Sets the specified value to the attachmentIndex() field.
static VkAttachmentSampleLocationsEXT	calloc()	Returns a new VkAttachmentSampleLocationsEXT instance allocated with memCalloc.
static VkAttachmentSampleLocationsEXT.Buffer	calloc(int capacity)	Returns a new VkAttachmentSampleLocationsEXT.Buffer instance allocated with memCalloc.
static VkAttachmentSampleLocationsEXT.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkAttachmentSampleLocationsEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAttachmentSampleLocationsEXT	calloc(MemoryStack stack)	Returns a new VkAttachmentSampleLocationsEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAttachmentSampleLocationsEXT	callocStack()	Deprecated.
static VkAttachmentSampleLocationsEXT.Buffer	callocStack(int capacity)	Deprecated.
static VkAttachmentSampleLocationsEXT.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkAttachmentSampleLocationsEXT	callocStack(MemoryStack stack)	Deprecated.
static VkAttachmentSampleLocationsEXT	create()	Returns a new VkAttachmentSampleLocationsEXT instance allocated with BufferUtils.
static VkAttachmentSampleLocationsEXT.Buffer	create(int capacity)	Returns a new VkAttachmentSampleLocationsEXT.Buffer instance allocated with BufferUtils.
static VkAttachmentSampleLocationsEXT	create(long address)	Returns a new VkAttachmentSampleLocationsEXT instance for the specified memory address.
static VkAttachmentSampleLocationsEXT.Buffer	create(long address, int capacity)	Create a VkAttachmentSampleLocationsEXT.Buffer instance at the specified memory.
static VkAttachmentSampleLocationsEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static VkAttachmentSampleLocationsEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkAttachmentSampleLocationsEXT	malloc()	Returns a new VkAttachmentSampleLocationsEXT instance allocated with memAlloc.
static VkAttachmentSampleLocationsEXT.Buffer	malloc(int capacity)	Returns a new VkAttachmentSampleLocationsEXT.Buffer instance allocated with memAlloc.
static VkAttachmentSampleLocationsEXT.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkAttachmentSampleLocationsEXT.Buffer instance allocated on the specified MemoryStack.
static VkAttachmentSampleLocationsEXT	malloc(MemoryStack stack)	Returns a new VkAttachmentSampleLocationsEXT instance allocated on the specified MemoryStack.
static VkAttachmentSampleLocationsEXT	mallocStack()	Deprecated.
static VkAttachmentSampleLocationsEXT.Buffer	mallocStack(int capacity)	Deprecated.
static VkAttachmentSampleLocationsEXT.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkAttachmentSampleLocationsEXT	mallocStack(MemoryStack stack)	Deprecated.
static int	nattachmentIndex(long struct)	Unsafe version of attachmentIndex().
static void	nattachmentIndex(long struct, int value)	Unsafe version of attachmentIndex.
static VkSampleLocationsInfoEXT	nsampleLocationsInfo(long struct)	Unsafe version of sampleLocationsInfo().
static void	nsampleLocationsInfo(long struct, VkSampleLocationsInfoEXT value)	Unsafe version of sampleLocationsInfo.
VkSampleLocationsInfoEXT	sampleLocationsInfo()	the sample locations state to use for the layout transition of the given attachment from the initial layout of the attachment to the image layout specified for the attachment in the first subpass using it.
VkAttachmentSampleLocationsEXT	sampleLocationsInfo(Consumer<VkSampleLocationsInfoEXT> consumer)	Passes the sampleLocationsInfo() field to the specified Consumer.
VkAttachmentSampleLocationsEXT	sampleLocationsInfo(VkSampleLocationsInfoEXT value)	Copies the specified VkSampleLocationsInfoEXT to the sampleLocationsInfo() field.
VkAttachmentSampleLocationsEXT	set(int attachmentIndex, VkSampleLocationsInfoEXT sampleLocationsInfo)	Initializes this struct with the specified values.
VkAttachmentSampleLocationsEXT	set(VkAttachmentSampleLocationsEXT src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
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

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.

ATTACHMENTINDEX

public static final int ATTACHMENTINDEX

The struct member offsets.

SAMPLELOCATIONSINFO

public static final int SAMPLELOCATIONSINFO

The struct member offsets.

Constructor Details

VkAttachmentSampleLocationsEXT

public VkAttachmentSampleLocationsEXT(ByteBuffer container)

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

attachmentIndex

public int attachmentIndex()

the index of the attachment for which the sample locations state is provided.

sampleLocationsInfo

public VkSampleLocationsInfoEXT sampleLocationsInfo()

the sample locations state to use for the layout transition of the given attachment from the initial layout of the attachment to the image layout specified for the attachment in the first subpass using it.

attachmentIndex

public VkAttachmentSampleLocationsEXT attachmentIndex(int value)

Sets the specified value to the attachmentIndex() field.

sampleLocationsInfo

public VkAttachmentSampleLocationsEXT sampleLocationsInfo(VkSampleLocationsInfoEXT value)

Copies the specified VkSampleLocationsInfoEXT to the sampleLocationsInfo() field.

sampleLocationsInfo

public VkAttachmentSampleLocationsEXT sampleLocationsInfo(Consumer<VkSampleLocationsInfoEXT> consumer)

Passes the sampleLocationsInfo() field to the specified Consumer.

set

public VkAttachmentSampleLocationsEXT set(int attachmentIndex,
 VkSampleLocationsInfoEXT sampleLocationsInfo)

Initializes this struct with the specified values.

set

public VkAttachmentSampleLocationsEXT set(VkAttachmentSampleLocationsEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkAttachmentSampleLocationsEXT malloc()

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

calloc

public static VkAttachmentSampleLocationsEXT calloc()

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

create

public static VkAttachmentSampleLocationsEXT create()

Returns a new VkAttachmentSampleLocationsEXT instance allocated with BufferUtils.

create

public static VkAttachmentSampleLocationsEXT create(long address)

Returns a new VkAttachmentSampleLocationsEXT instance for the specified memory address.

createSafe

@Nullable
public static VkAttachmentSampleLocationsEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkAttachmentSampleLocationsEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkAttachmentSampleLocationsEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkAttachmentSampleLocationsEXT.Buffer create(int capacity)

Returns a new VkAttachmentSampleLocationsEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkAttachmentSampleLocationsEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkAttachmentSampleLocationsEXT mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkAttachmentSampleLocationsEXT callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkAttachmentSampleLocationsEXT mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkAttachmentSampleLocationsEXT callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

malloc

public static VkAttachmentSampleLocationsEXT malloc(MemoryStack stack)

Returns a new VkAttachmentSampleLocationsEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkAttachmentSampleLocationsEXT calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkAttachmentSampleLocationsEXT.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

nattachmentIndex

public static int nattachmentIndex(long struct)

Unsafe version of attachmentIndex().

nsampleLocationsInfo

public static VkSampleLocationsInfoEXT nsampleLocationsInfo(long struct)

Unsafe version of sampleLocationsInfo().

nattachmentIndex

public static void nattachmentIndex(long struct,
 int value)

Unsafe version of attachmentIndex.

nsampleLocationsInfo

public static void nsampleLocationsInfo(long struct,
 VkSampleLocationsInfoEXT value)

Unsafe version of sampleLocationsInfo.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate