Package org.lwjgl.vulkan

Class VkRenderPassSampleLocationsBeginInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkRenderPassSampleLocationsBeginInfoEXT>

org.lwjgl.vulkan.VkRenderPassSampleLocationsBeginInfoEXT

All Implemented Interfaces:

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

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

Structure specifying sample locations to use for the layout transition of custom sample locations compatible depth/stencil attachments.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RENDER_PASS_SAMPLE_LOCATIONS_BEGIN_INFO_EXT
• If attachmentInitialSampleLocationsCount is not 0, pAttachmentInitialSampleLocations must be a valid pointer to an array of attachmentInitialSampleLocationsCount valid VkAttachmentSampleLocationsEXT structures
• If postSubpassSampleLocationsCount is not 0, pPostSubpassSampleLocations must be a valid pointer to an array of postSubpassSampleLocationsCount valid VkSubpassSampleLocationsEXT structures

See Also

VkAttachmentSampleLocationsEXT, VkSubpassSampleLocationsEXT

Layout

 struct VkRenderPassSampleLocationsBeginInfoEXT {
     VkStructureType sType();
     void const * pNext();
     uint32_t attachmentInitialSampleLocationsCount();
     VkAttachmentSampleLocationsEXT const * pAttachmentInitialSampleLocations();
     uint32_t postSubpassSampleLocationsCount();
     VkSubpassSampleLocationsEXT const * pPostSubpassSampleLocations();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
int	attachmentInitialSampleLocationsCount()	the number of elements in the pAttachmentInitialSampleLocations array.
static VkRenderPassSampleLocationsBeginInfoEXT	calloc()	Returns a new VkRenderPassSampleLocationsBeginInfoEXT instance allocated with memCalloc.
static VkRenderPassSampleLocationsBeginInfoEXT.Buffer	calloc(int capacity)	Returns a new VkRenderPassSampleLocationsBeginInfoEXT.Buffer instance allocated with memCalloc.
static VkRenderPassSampleLocationsBeginInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderPassSampleLocationsBeginInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkRenderPassSampleLocationsBeginInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderPassSampleLocationsBeginInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkRenderPassSampleLocationsBeginInfoEXT	callocStack()	Deprecated.
static VkRenderPassSampleLocationsBeginInfoEXT.Buffer	callocStack(int capacity)	Deprecated.
static VkRenderPassSampleLocationsBeginInfoEXT.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkRenderPassSampleLocationsBeginInfoEXT	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkRenderPassSampleLocationsBeginInfoEXT	create()	Returns a new VkRenderPassSampleLocationsBeginInfoEXT instance allocated with BufferUtils.
static VkRenderPassSampleLocationsBeginInfoEXT.Buffer	create(int capacity)	Returns a new VkRenderPassSampleLocationsBeginInfoEXT.Buffer instance allocated with BufferUtils.
static VkRenderPassSampleLocationsBeginInfoEXT	create(long address)	Returns a new VkRenderPassSampleLocationsBeginInfoEXT instance for the specified memory address.
static VkRenderPassSampleLocationsBeginInfoEXT.Buffer	create(long address, int capacity)	Create a VkRenderPassSampleLocationsBeginInfoEXT.Buffer instance at the specified memory.
static @Nullable VkRenderPassSampleLocationsBeginInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkRenderPassSampleLocationsBeginInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkRenderPassSampleLocationsBeginInfoEXT	malloc()	Returns a new VkRenderPassSampleLocationsBeginInfoEXT instance allocated with memAlloc.
static VkRenderPassSampleLocationsBeginInfoEXT.Buffer	malloc(int capacity)	Returns a new VkRenderPassSampleLocationsBeginInfoEXT.Buffer instance allocated with memAlloc.
static VkRenderPassSampleLocationsBeginInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderPassSampleLocationsBeginInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkRenderPassSampleLocationsBeginInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderPassSampleLocationsBeginInfoEXT instance allocated on the specified MemoryStack.
static VkRenderPassSampleLocationsBeginInfoEXT	mallocStack()	Deprecated.
static VkRenderPassSampleLocationsBeginInfoEXT.Buffer	mallocStack(int capacity)	Deprecated.
static VkRenderPassSampleLocationsBeginInfoEXT.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkRenderPassSampleLocationsBeginInfoEXT	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static int	nattachmentInitialSampleLocationsCount(long struct)	Unsafe version of attachmentInitialSampleLocationsCount().
static void	nattachmentInitialSampleLocationsCount(long struct, int value)	Sets the specified value to the attachmentInitialSampleLocationsCount field of the specified struct.
static @Nullable VkAttachmentSampleLocationsEXT.Buffer	npAttachmentInitialSampleLocations(long struct)	Unsafe version of pAttachmentInitialSampleLocations().
static void	npAttachmentInitialSampleLocations(long struct, @Nullable VkAttachmentSampleLocationsEXT.Buffer value)	Unsafe version of pAttachmentInitialSampleLocations.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	npostSubpassSampleLocationsCount(long struct)	Unsafe version of postSubpassSampleLocationsCount().
static void	npostSubpassSampleLocationsCount(long struct, int value)	Sets the specified value to the postSubpassSampleLocationsCount field of the specified struct.
static @Nullable VkSubpassSampleLocationsEXT.Buffer	npPostSubpassSampleLocations(long struct)	Unsafe version of pPostSubpassSampleLocations().
static void	npPostSubpassSampleLocations(long struct, @Nullable VkSubpassSampleLocationsEXT.Buffer value)	Unsafe version of pPostSubpassSampleLocations.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
@Nullable VkAttachmentSampleLocationsEXT.Buffer	pAttachmentInitialSampleLocations()	a pointer to an array of attachmentInitialSampleLocationsCount VkAttachmentSampleLocationsEXT structures specifying the attachment indices and their corresponding sample location state.
VkRenderPassSampleLocationsBeginInfoEXT	pAttachmentInitialSampleLocations(@Nullable VkAttachmentSampleLocationsEXT.Buffer value)	Sets the address of the specified VkAttachmentSampleLocationsEXT.Buffer to the pAttachmentInitialSampleLocations() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkRenderPassSampleLocationsBeginInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
int	postSubpassSampleLocationsCount()	the number of elements in the pPostSubpassSampleLocations array.
@Nullable VkSubpassSampleLocationsEXT.Buffer	pPostSubpassSampleLocations()	a pointer to an array of postSubpassSampleLocationsCount VkSubpassSampleLocationsEXT structures specifying the subpass indices and their corresponding sample location state.
VkRenderPassSampleLocationsBeginInfoEXT	pPostSubpassSampleLocations(@Nullable VkSubpassSampleLocationsEXT.Buffer value)	Sets the address of the specified VkSubpassSampleLocationsEXT.Buffer to the pPostSubpassSampleLocations() field.
VkRenderPassSampleLocationsBeginInfoEXT	set(int sType, long pNext, @Nullable VkAttachmentSampleLocationsEXT.Buffer pAttachmentInitialSampleLocations, @Nullable VkSubpassSampleLocationsEXT.Buffer pPostSubpassSampleLocations)	Initializes this struct with the specified values.
VkRenderPassSampleLocationsBeginInfoEXT	set(VkRenderPassSampleLocationsBeginInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkRenderPassSampleLocationsBeginInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkRenderPassSampleLocationsBeginInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_RENDER_PASS_SAMPLE_LOCATIONS_BEGIN_INFO_EXT 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.

ATTACHMENTINITIALSAMPLELOCATIONSCOUNT

public static final int ATTACHMENTINITIALSAMPLELOCATIONSCOUNT

The struct member offsets.

PATTACHMENTINITIALSAMPLELOCATIONS

public static final int PATTACHMENTINITIALSAMPLELOCATIONS

The struct member offsets.

POSTSUBPASSSAMPLELOCATIONSCOUNT

public static final int POSTSUBPASSSAMPLELOCATIONSCOUNT

The struct member offsets.

PPOSTSUBPASSSAMPLELOCATIONS

public static final int PPOSTSUBPASSSAMPLELOCATIONS

The struct member offsets.

Constructor Details

VkRenderPassSampleLocationsBeginInfoEXT

public VkRenderPassSampleLocationsBeginInfoEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

attachmentInitialSampleLocationsCount

public int attachmentInitialSampleLocationsCount()

the number of elements in the pAttachmentInitialSampleLocations array.

pAttachmentInitialSampleLocations

public @Nullable VkAttachmentSampleLocationsEXT.Buffer pAttachmentInitialSampleLocations()

a pointer to an array of attachmentInitialSampleLocationsCount VkAttachmentSampleLocationsEXT structures specifying the attachment indices and their corresponding sample location state. Each element of pAttachmentInitialSampleLocations can specify the sample location state to use in the automatic layout transition performed to transition a depth/stencil attachment from the initial layout of the attachment to the image layout specified for the attachment in the first subpass using it.

postSubpassSampleLocationsCount

public int postSubpassSampleLocationsCount()

the number of elements in the pPostSubpassSampleLocations array.

pPostSubpassSampleLocations

public @Nullable VkSubpassSampleLocationsEXT.Buffer pPostSubpassSampleLocations()

a pointer to an array of postSubpassSampleLocationsCount VkSubpassSampleLocationsEXT structures specifying the subpass indices and their corresponding sample location state. Each element of pPostSubpassSampleLocations can specify the sample location state to use in the automatic layout transition performed to transition the depth/stencil attachment used by the specified subpass to the image layout specified in a dependent subpass or to the final layout of the attachment in case the specified subpass is the last subpass using that attachment. In addition, if VkPhysicalDeviceSampleLocationsPropertiesEXT::variableSampleLocations is FALSE, each element of pPostSubpassSampleLocations must specify the sample location state that matches the sample locations used by all pipelines that will be bound to a command buffer during the specified subpass. If variableSampleLocations is TRUE, the sample locations used for rasterization do not depend on pPostSubpassSampleLocations.

sType

public VkRenderPassSampleLocationsBeginInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkRenderPassSampleLocationsBeginInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_RENDER_PASS_SAMPLE_LOCATIONS_BEGIN_INFO_EXT value to the sType() field.

pNext

public VkRenderPassSampleLocationsBeginInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

pAttachmentInitialSampleLocations

public VkRenderPassSampleLocationsBeginInfoEXT pAttachmentInitialSampleLocations(@Nullable VkAttachmentSampleLocationsEXT.Buffer value)

Sets the address of the specified VkAttachmentSampleLocationsEXT.Buffer to the pAttachmentInitialSampleLocations() field.

pPostSubpassSampleLocations

public VkRenderPassSampleLocationsBeginInfoEXT pPostSubpassSampleLocations(@Nullable VkSubpassSampleLocationsEXT.Buffer value)

Sets the address of the specified VkSubpassSampleLocationsEXT.Buffer to the pPostSubpassSampleLocations() field.

set

public VkRenderPassSampleLocationsBeginInfoEXT set(int sType,
 long pNext,
 @Nullable VkAttachmentSampleLocationsEXT.Buffer pAttachmentInitialSampleLocations,
 @Nullable VkSubpassSampleLocationsEXT.Buffer pPostSubpassSampleLocations)

Initializes this struct with the specified values.

set

public VkRenderPassSampleLocationsBeginInfoEXT set(VkRenderPassSampleLocationsBeginInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkRenderPassSampleLocationsBeginInfoEXT malloc()

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

calloc

public static VkRenderPassSampleLocationsBeginInfoEXT calloc()

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

create

public static VkRenderPassSampleLocationsBeginInfoEXT create()

Returns a new VkRenderPassSampleLocationsBeginInfoEXT instance allocated with BufferUtils.

create

public static VkRenderPassSampleLocationsBeginInfoEXT create(long address)

Returns a new VkRenderPassSampleLocationsBeginInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkRenderPassSampleLocationsBeginInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkRenderPassSampleLocationsBeginInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkRenderPassSampleLocationsBeginInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkRenderPassSampleLocationsBeginInfoEXT.Buffer create(int capacity)

Returns a new VkRenderPassSampleLocationsBeginInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkRenderPassSampleLocationsBeginInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkRenderPassSampleLocationsBeginInfoEXT mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkRenderPassSampleLocationsBeginInfoEXT callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkRenderPassSampleLocationsBeginInfoEXT mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkRenderPassSampleLocationsBeginInfoEXT callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkRenderPassSampleLocationsBeginInfoEXT.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkRenderPassSampleLocationsBeginInfoEXT.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

malloc

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

Returns a new VkRenderPassSampleLocationsBeginInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nattachmentInitialSampleLocationsCount

public static int nattachmentInitialSampleLocationsCount(long struct)

Unsafe version of attachmentInitialSampleLocationsCount().

npAttachmentInitialSampleLocations

public static @Nullable VkAttachmentSampleLocationsEXT.Buffer npAttachmentInitialSampleLocations(long struct)

Unsafe version of pAttachmentInitialSampleLocations().

npostSubpassSampleLocationsCount

public static int npostSubpassSampleLocationsCount(long struct)

Unsafe version of postSubpassSampleLocationsCount().

npPostSubpassSampleLocations

public static @Nullable VkSubpassSampleLocationsEXT.Buffer npPostSubpassSampleLocations(long struct)

Unsafe version of pPostSubpassSampleLocations().

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.

nattachmentInitialSampleLocationsCount

public static void nattachmentInitialSampleLocationsCount(long struct,
 int value)

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

npAttachmentInitialSampleLocations

public static void npAttachmentInitialSampleLocations(long struct,
 @Nullable VkAttachmentSampleLocationsEXT.Buffer value)

Unsafe version of pAttachmentInitialSampleLocations.

npostSubpassSampleLocationsCount

public static void npostSubpassSampleLocationsCount(long struct,
 int value)

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

npPostSubpassSampleLocations

public static void npPostSubpassSampleLocations(long struct,
 @Nullable VkSubpassSampleLocationsEXT.Buffer value)

Unsafe version of pPostSubpassSampleLocations.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate