Package org.lwjgl.vulkan

Class VkSampleLocationsInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkSampleLocationsInfoEXT>

org.lwjgl.vulkan.VkSampleLocationsInfoEXT

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkSampleLocationsInfoEXT
extends Struct<VkSampleLocationsInfoEXT>
implements NativeResource

 struct VkSampleLocationsInfoEXT {
     VkStructureType sType;
     void const * pNext;
     VkSampleCountFlagBits sampleLocationsPerPixel;
     {@link VkExtent2D VkExtent2D} sampleLocationGridSize;
     uint32_t sampleLocationsCount;
     {@link VkSampleLocationEXT VkSampleLocationEXT} const * pSampleLocations;
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkSampleLocationsInfoEXT	calloc()	Returns a new VkSampleLocationsInfoEXT instance allocated with memCalloc.
static VkSampleLocationsInfoEXT.Buffer	calloc(int capacity)	Returns a new VkSampleLocationsInfoEXT.Buffer instance allocated with memCalloc.
static VkSampleLocationsInfoEXT.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkSampleLocationsInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSampleLocationsInfoEXT	calloc(MemoryStack stack)	Returns a new VkSampleLocationsInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSampleLocationsInfoEXT	callocStack()	Deprecated.
static VkSampleLocationsInfoEXT.Buffer	callocStack(int capacity)	Deprecated.
static VkSampleLocationsInfoEXT.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkSampleLocationsInfoEXT	callocStack(MemoryStack stack)	Deprecated.
static VkSampleLocationsInfoEXT	create()	Returns a new VkSampleLocationsInfoEXT instance allocated with BufferUtils.
static VkSampleLocationsInfoEXT.Buffer	create(int capacity)	Returns a new VkSampleLocationsInfoEXT.Buffer instance allocated with BufferUtils.
static VkSampleLocationsInfoEXT	create(long address)	Returns a new VkSampleLocationsInfoEXT instance for the specified memory address.
static VkSampleLocationsInfoEXT.Buffer	create(long address, int capacity)	Create a VkSampleLocationsInfoEXT.Buffer instance at the specified memory.
static @Nullable VkSampleLocationsInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkSampleLocationsInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkSampleLocationsInfoEXT	malloc()	Returns a new VkSampleLocationsInfoEXT instance allocated with memAlloc.
static VkSampleLocationsInfoEXT.Buffer	malloc(int capacity)	Returns a new VkSampleLocationsInfoEXT.Buffer instance allocated with memAlloc.
static VkSampleLocationsInfoEXT.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkSampleLocationsInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkSampleLocationsInfoEXT	malloc(MemoryStack stack)	Returns a new VkSampleLocationsInfoEXT instance allocated on the specified MemoryStack.
static VkSampleLocationsInfoEXT	mallocStack()	Deprecated.
static VkSampleLocationsInfoEXT.Buffer	mallocStack(int capacity)	Deprecated.
static VkSampleLocationsInfoEXT.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkSampleLocationsInfoEXT	mallocStack(MemoryStack stack)	Deprecated.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static @Nullable VkSampleLocationEXT.Buffer	npSampleLocations(long struct)	Unsafe version of pSampleLocations().
static void	npSampleLocations(long struct, @Nullable VkSampleLocationEXT.Buffer value)	Unsafe version of pSampleLocations.
static VkExtent2D	nsampleLocationGridSize(long struct)	Unsafe version of sampleLocationGridSize().
static void	nsampleLocationGridSize(long struct, VkExtent2D value)	Unsafe version of sampleLocationGridSize.
static int	nsampleLocationsCount(long struct)	Unsafe version of sampleLocationsCount().
static void	nsampleLocationsCount(long struct, int value)	Sets the specified value to the sampleLocationsCount field of the specified struct.
static int	nsampleLocationsPerPixel(long struct)	Unsafe version of sampleLocationsPerPixel().
static void	nsampleLocationsPerPixel(long struct, int value)	Unsafe version of sampleLocationsPerPixel.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()
VkSampleLocationsInfoEXT	pNext(long value)	Sets the specified value to the pNext field.
@Nullable VkSampleLocationEXT.Buffer	pSampleLocations()
VkSampleLocationsInfoEXT	pSampleLocations(@Nullable VkSampleLocationEXT.Buffer value)	Sets the address of the specified VkSampleLocationEXT.Buffer to the pSampleLocations field.
VkExtent2D	sampleLocationGridSize()
VkSampleLocationsInfoEXT	sampleLocationGridSize(Consumer<VkExtent2D> consumer)	Passes the sampleLocationGridSize field to the specified Consumer.
VkSampleLocationsInfoEXT	sampleLocationGridSize(VkExtent2D value)	Copies the specified VkExtent2D to the sampleLocationGridSize field.
int	sampleLocationsCount()
int	sampleLocationsPerPixel()
VkSampleLocationsInfoEXT	sampleLocationsPerPixel(int value)	Sets the specified value to the sampleLocationsPerPixel field.
VkSampleLocationsInfoEXT	set(int sType, long pNext, int sampleLocationsPerPixel, VkExtent2D sampleLocationGridSize, @Nullable VkSampleLocationEXT.Buffer pSampleLocations)	Initializes this struct with the specified values.
VkSampleLocationsInfoEXT	set(VkSampleLocationsInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()
VkSampleLocationsInfoEXT	sType(int value)	Sets the specified value to the sType field.
VkSampleLocationsInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_SAMPLE_LOCATIONS_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.

SAMPLELOCATIONSPERPIXEL

public static final int SAMPLELOCATIONSPERPIXEL

The struct member offsets.

SAMPLELOCATIONGRIDSIZE

public static final int SAMPLELOCATIONGRIDSIZE

The struct member offsets.

SAMPLELOCATIONSCOUNT

public static final int SAMPLELOCATIONSCOUNT

The struct member offsets.

PSAMPLELOCATIONS

public static final int PSAMPLELOCATIONS

The struct member offsets.

Constructor Details

VkSampleLocationsInfoEXT

public VkSampleLocationsInfoEXT(ByteBuffer container)

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

sType

public int sType()

Returns:

the value of the sType field.

pNext

public long pNext()

Returns:

the value of the pNext field.

sampleLocationsPerPixel

public int sampleLocationsPerPixel()

Returns:

the value of the sampleLocationsPerPixel field.

sampleLocationGridSize

public VkExtent2D sampleLocationGridSize()

Returns:

a VkExtent2D view of the sampleLocationGridSize field.

sampleLocationsCount

public int sampleLocationsCount()

Returns:

the value of the sampleLocationsCount field.

pSampleLocations

public @Nullable VkSampleLocationEXT.Buffer pSampleLocations()

Returns:

a VkSampleLocationEXT.Buffer view of the struct array pointed to by the pSampleLocations field.

sType

public VkSampleLocationsInfoEXT sType(int value)

Sets the specified value to the sType field.

sType$Default

public VkSampleLocationsInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_SAMPLE_LOCATIONS_INFO_EXT value to the sType field.

pNext

public VkSampleLocationsInfoEXT pNext(long value)

Sets the specified value to the pNext field.

sampleLocationsPerPixel

public VkSampleLocationsInfoEXT sampleLocationsPerPixel(int value)

Sets the specified value to the sampleLocationsPerPixel field.

sampleLocationGridSize

public VkSampleLocationsInfoEXT sampleLocationGridSize(VkExtent2D value)

Copies the specified VkExtent2D to the sampleLocationGridSize field.

sampleLocationGridSize

public VkSampleLocationsInfoEXT sampleLocationGridSize(Consumer<VkExtent2D> consumer)

Passes the sampleLocationGridSize field to the specified Consumer.

pSampleLocations

public VkSampleLocationsInfoEXT pSampleLocations(@Nullable VkSampleLocationEXT.Buffer value)

Sets the address of the specified VkSampleLocationEXT.Buffer to the pSampleLocations field.

set

public VkSampleLocationsInfoEXT set(int sType,
 long pNext,
 int sampleLocationsPerPixel,
 VkExtent2D sampleLocationGridSize,
 @Nullable VkSampleLocationEXT.Buffer pSampleLocations)

Initializes this struct with the specified values.

set

public VkSampleLocationsInfoEXT set(VkSampleLocationsInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkSampleLocationsInfoEXT malloc()

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

calloc

public static VkSampleLocationsInfoEXT calloc()

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

create

public static VkSampleLocationsInfoEXT create()

Returns a new VkSampleLocationsInfoEXT instance allocated with BufferUtils.

create

public static VkSampleLocationsInfoEXT create(long address)

Returns a new VkSampleLocationsInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkSampleLocationsInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkSampleLocationsInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkSampleLocationsInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkSampleLocationsInfoEXT.Buffer create(int capacity)

Returns a new VkSampleLocationsInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkSampleLocationsInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkSampleLocationsInfoEXT mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkSampleLocationsInfoEXT callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkSampleLocationsInfoEXT mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkSampleLocationsInfoEXT callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

malloc

public static VkSampleLocationsInfoEXT malloc(MemoryStack stack)

Returns a new VkSampleLocationsInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkSampleLocationsInfoEXT calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsampleLocationsPerPixel

public static int nsampleLocationsPerPixel(long struct)

Unsafe version of sampleLocationsPerPixel().

nsampleLocationGridSize

public static VkExtent2D nsampleLocationGridSize(long struct)

Unsafe version of sampleLocationGridSize().

nsampleLocationsCount

public static int nsampleLocationsCount(long struct)

Unsafe version of sampleLocationsCount().

npSampleLocations

public static @Nullable VkSampleLocationEXT.Buffer npSampleLocations(long struct)

Unsafe version of pSampleLocations().

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.

nsampleLocationsPerPixel

public static void nsampleLocationsPerPixel(long struct,
 int value)

Unsafe version of sampleLocationsPerPixel.

nsampleLocationGridSize

public static void nsampleLocationGridSize(long struct,
 VkExtent2D value)

Unsafe version of sampleLocationGridSize.

nsampleLocationsCount

public static void nsampleLocationsCount(long struct,
 int value)

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

npSampleLocations

public static void npSampleLocations(long struct,
 @Nullable VkSampleLocationEXT.Buffer value)

Unsafe version of pSampleLocations.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate