Package org.lwjgl.vulkan

Class VkPipelineSampleLocationsStateCreateInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPipelineSampleLocationsStateCreateInfoEXT>

org.lwjgl.vulkan.VkPipelineSampleLocationsStateCreateInfoEXT

All Implemented Interfaces:

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

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

Structure specifying sample locations for a pipeline.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_SAMPLE_LOCATIONS_STATE_CREATE_INFO_EXT
• sampleLocationsInfo must be a valid VkSampleLocationsInfoEXT structure

See Also

VkSampleLocationsInfoEXT

Layout

 struct VkPipelineSampleLocationsStateCreateInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkBool32 sampleLocationsEnable();
     VkSampleLocationsInfoEXT sampleLocationsInfo();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkPipelineSampleLocationsStateCreateInfoEXT	calloc()	Returns a new VkPipelineSampleLocationsStateCreateInfoEXT instance allocated with memCalloc.
static VkPipelineSampleLocationsStateCreateInfoEXT.Buffer	calloc(int capacity)	Returns a new VkPipelineSampleLocationsStateCreateInfoEXT.Buffer instance allocated with memCalloc.
static VkPipelineSampleLocationsStateCreateInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineSampleLocationsStateCreateInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineSampleLocationsStateCreateInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineSampleLocationsStateCreateInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineSampleLocationsStateCreateInfoEXT	callocStack()	Deprecated.
static VkPipelineSampleLocationsStateCreateInfoEXT.Buffer	callocStack(int capacity)	Deprecated.
static VkPipelineSampleLocationsStateCreateInfoEXT.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPipelineSampleLocationsStateCreateInfoEXT	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPipelineSampleLocationsStateCreateInfoEXT	create()	Returns a new VkPipelineSampleLocationsStateCreateInfoEXT instance allocated with BufferUtils.
static VkPipelineSampleLocationsStateCreateInfoEXT.Buffer	create(int capacity)	Returns a new VkPipelineSampleLocationsStateCreateInfoEXT.Buffer instance allocated with BufferUtils.
static VkPipelineSampleLocationsStateCreateInfoEXT	create(long address)	Returns a new VkPipelineSampleLocationsStateCreateInfoEXT instance for the specified memory address.
static VkPipelineSampleLocationsStateCreateInfoEXT.Buffer	create(long address, int capacity)	Create a VkPipelineSampleLocationsStateCreateInfoEXT.Buffer instance at the specified memory.
static @Nullable VkPipelineSampleLocationsStateCreateInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPipelineSampleLocationsStateCreateInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkPipelineSampleLocationsStateCreateInfoEXT	malloc()	Returns a new VkPipelineSampleLocationsStateCreateInfoEXT instance allocated with memAlloc.
static VkPipelineSampleLocationsStateCreateInfoEXT.Buffer	malloc(int capacity)	Returns a new VkPipelineSampleLocationsStateCreateInfoEXT.Buffer instance allocated with memAlloc.
static VkPipelineSampleLocationsStateCreateInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineSampleLocationsStateCreateInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkPipelineSampleLocationsStateCreateInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineSampleLocationsStateCreateInfoEXT instance allocated on the specified MemoryStack.
static VkPipelineSampleLocationsStateCreateInfoEXT	mallocStack()	Deprecated.
static VkPipelineSampleLocationsStateCreateInfoEXT.Buffer	mallocStack(int capacity)	Deprecated.
static VkPipelineSampleLocationsStateCreateInfoEXT.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPipelineSampleLocationsStateCreateInfoEXT	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsampleLocationsEnable(long struct)	Unsafe version of sampleLocationsEnable().
static void	nsampleLocationsEnable(long struct, int value)	Unsafe version of sampleLocationsEnable.
static VkSampleLocationsInfoEXT	nsampleLocationsInfo(long struct)	Unsafe version of sampleLocationsInfo().
static void	nsampleLocationsInfo(long struct, VkSampleLocationsInfoEXT value)	Unsafe version of sampleLocationsInfo.
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.
VkPipelineSampleLocationsStateCreateInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
boolean	sampleLocationsEnable()	controls whether custom sample locations are used.
VkPipelineSampleLocationsStateCreateInfoEXT	sampleLocationsEnable(boolean value)	Sets the specified value to the sampleLocationsEnable() field.
VkSampleLocationsInfoEXT	sampleLocationsInfo()	the sample locations to use during rasterization if sampleLocationsEnable is TRUE and the graphics pipeline is not created with DYNAMIC_STATE_SAMPLE_LOCATIONS_EXT.
VkPipelineSampleLocationsStateCreateInfoEXT	sampleLocationsInfo(Consumer<VkSampleLocationsInfoEXT> consumer)	Passes the sampleLocationsInfo() field to the specified Consumer.
VkPipelineSampleLocationsStateCreateInfoEXT	sampleLocationsInfo(VkSampleLocationsInfoEXT value)	Copies the specified VkSampleLocationsInfoEXT to the sampleLocationsInfo() field.
VkPipelineSampleLocationsStateCreateInfoEXT	set(int sType, long pNext, boolean sampleLocationsEnable, VkSampleLocationsInfoEXT sampleLocationsInfo)	Initializes this struct with the specified values.
VkPipelineSampleLocationsStateCreateInfoEXT	set(VkPipelineSampleLocationsStateCreateInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPipelineSampleLocationsStateCreateInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkPipelineSampleLocationsStateCreateInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_PIPELINE_SAMPLE_LOCATIONS_STATE_CREATE_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.

SAMPLELOCATIONSENABLE

public static final int SAMPLELOCATIONSENABLE

The struct member offsets.

SAMPLELOCATIONSINFO

public static final int SAMPLELOCATIONSINFO

The struct member offsets.

Constructor Details

VkPipelineSampleLocationsStateCreateInfoEXT

public VkPipelineSampleLocationsStateCreateInfoEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

sampleLocationsEnable

public boolean sampleLocationsEnable()

controls whether custom sample locations are used. If sampleLocationsEnable is FALSE, the default sample locations are used and the values specified in sampleLocationsInfo are ignored.

sampleLocationsInfo

public VkSampleLocationsInfoEXT sampleLocationsInfo()

the sample locations to use during rasterization if sampleLocationsEnable is TRUE and the graphics pipeline is not created with DYNAMIC_STATE_SAMPLE_LOCATIONS_EXT.

sType

public VkPipelineSampleLocationsStateCreateInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPipelineSampleLocationsStateCreateInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_PIPELINE_SAMPLE_LOCATIONS_STATE_CREATE_INFO_EXT value to the sType() field.

pNext

public VkPipelineSampleLocationsStateCreateInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

sampleLocationsEnable

public VkPipelineSampleLocationsStateCreateInfoEXT sampleLocationsEnable(boolean value)

Sets the specified value to the sampleLocationsEnable() field.

sampleLocationsInfo

public VkPipelineSampleLocationsStateCreateInfoEXT sampleLocationsInfo(VkSampleLocationsInfoEXT value)

Copies the specified VkSampleLocationsInfoEXT to the sampleLocationsInfo() field.

sampleLocationsInfo

public VkPipelineSampleLocationsStateCreateInfoEXT sampleLocationsInfo(Consumer<VkSampleLocationsInfoEXT> consumer)

Passes the sampleLocationsInfo() field to the specified Consumer.

set

public VkPipelineSampleLocationsStateCreateInfoEXT set(int sType,
 long pNext,
 boolean sampleLocationsEnable,
 VkSampleLocationsInfoEXT sampleLocationsInfo)

Initializes this struct with the specified values.

set

public VkPipelineSampleLocationsStateCreateInfoEXT set(VkPipelineSampleLocationsStateCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPipelineSampleLocationsStateCreateInfoEXT malloc()

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

calloc

public static VkPipelineSampleLocationsStateCreateInfoEXT calloc()

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

create

public static VkPipelineSampleLocationsStateCreateInfoEXT create()

Returns a new VkPipelineSampleLocationsStateCreateInfoEXT instance allocated with BufferUtils.

create

public static VkPipelineSampleLocationsStateCreateInfoEXT create(long address)

Returns a new VkPipelineSampleLocationsStateCreateInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkPipelineSampleLocationsStateCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPipelineSampleLocationsStateCreateInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPipelineSampleLocationsStateCreateInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPipelineSampleLocationsStateCreateInfoEXT.Buffer create(int capacity)

Returns a new VkPipelineSampleLocationsStateCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPipelineSampleLocationsStateCreateInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkPipelineSampleLocationsStateCreateInfoEXT mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkPipelineSampleLocationsStateCreateInfoEXT callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkPipelineSampleLocationsStateCreateInfoEXT.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 VkPipelineSampleLocationsStateCreateInfoEXT.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 VkPipelineSampleLocationsStateCreateInfoEXT malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkPipelineSampleLocationsStateCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsampleLocationsEnable

public static int nsampleLocationsEnable(long struct)

Unsafe version of sampleLocationsEnable().

nsampleLocationsInfo

public static VkSampleLocationsInfoEXT nsampleLocationsInfo(long struct)

Unsafe version of sampleLocationsInfo().

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.

nsampleLocationsEnable

public static void nsampleLocationsEnable(long struct,
 int value)

Unsafe version of sampleLocationsEnable.

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