Class VkCoarseSampleOrderCustomNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkCoarseSampleOrderCustomNV>

org.lwjgl.vulkan.VkCoarseSampleOrderCustomNV

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkCoarseSampleOrderCustomNV
extends Struct<VkCoarseSampleOrderCustomNV>
implements NativeResource

struct VkCoarseSampleOrderCustomNV {
    VkShadingRatePaletteEntryNV shadingRate;
    uint32_t sampleCount;
    uint32_t sampleLocationCount;
    VkCoarseSampleLocationNV const * pSampleLocations;
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkCoarseSampleOrderCustomNV.Buffer	An array of VkCoarseSampleOrderCustomNV structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	PSAMPLELOCATIONS	The struct member offsets.
static final int	SAMPLECOUNT	The struct member offsets.
static final int	SAMPLELOCATIONCOUNT	The struct member offsets.
static final int	SHADINGRATE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkCoarseSampleOrderCustomNV	calloc()	Returns a new VkCoarseSampleOrderCustomNV instance allocated with memCalloc.
static VkCoarseSampleOrderCustomNV.Buffer	calloc(int capacity)	Returns a new VkCoarseSampleOrderCustomNV.Buffer instance allocated with memCalloc.
static VkCoarseSampleOrderCustomNV.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkCoarseSampleOrderCustomNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkCoarseSampleOrderCustomNV	calloc(MemoryStack stack)	Returns a new VkCoarseSampleOrderCustomNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkCoarseSampleOrderCustomNV	create()	Returns a new VkCoarseSampleOrderCustomNV instance allocated with BufferUtils.
static VkCoarseSampleOrderCustomNV.Buffer	create(int capacity)	Returns a new VkCoarseSampleOrderCustomNV.Buffer instance allocated with BufferUtils.
static VkCoarseSampleOrderCustomNV	create(long address)	Returns a new VkCoarseSampleOrderCustomNV instance for the specified memory address.
static VkCoarseSampleOrderCustomNV.Buffer	create(long address, int capacity)	Create a VkCoarseSampleOrderCustomNV.Buffer instance at the specified memory.
static @Nullable VkCoarseSampleOrderCustomNV	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkCoarseSampleOrderCustomNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkCoarseSampleOrderCustomNV	malloc()	Returns a new VkCoarseSampleOrderCustomNV instance allocated with memAlloc.
static VkCoarseSampleOrderCustomNV.Buffer	malloc(int capacity)	Returns a new VkCoarseSampleOrderCustomNV.Buffer instance allocated with memAlloc.
static VkCoarseSampleOrderCustomNV.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkCoarseSampleOrderCustomNV.Buffer instance allocated on the specified MemoryStack.
static VkCoarseSampleOrderCustomNV	malloc(MemoryStack stack)	Returns a new VkCoarseSampleOrderCustomNV instance allocated on the specified MemoryStack.
static VkCoarseSampleLocationNV.Buffer	npSampleLocations(long struct)	Unsafe version of pSampleLocations().
static void	npSampleLocations(long struct, VkCoarseSampleLocationNV.Buffer value)	Unsafe version of pSampleLocations.
static int	nsampleCount(long struct)	Unsafe version of sampleCount().
static void	nsampleCount(long struct, int value)	Unsafe version of sampleCount.
static int	nsampleLocationCount(long struct)	Unsafe version of sampleLocationCount().
static void	nsampleLocationCount(long struct, int value)	Sets the specified value to the sampleLocationCount field of the specified struct.
static int	nshadingRate(long struct)	Unsafe version of shadingRate().
static void	nshadingRate(long struct, int value)	Unsafe version of shadingRate.
VkCoarseSampleLocationNV.Buffer	pSampleLocations()
VkCoarseSampleOrderCustomNV	pSampleLocations(VkCoarseSampleLocationNV.Buffer value)	Sets the address of the specified VkCoarseSampleLocationNV.Buffer to the pSampleLocations field.
int	sampleCount()
VkCoarseSampleOrderCustomNV	sampleCount(int value)	Sets the specified value to the sampleCount field.
int	sampleLocationCount()
VkCoarseSampleOrderCustomNV	set(int shadingRate, int sampleCount, VkCoarseSampleLocationNV.Buffer pSampleLocations)	Initializes this struct with the specified values.
VkCoarseSampleOrderCustomNV	set(VkCoarseSampleOrderCustomNV src)	Copies the specified struct data to this struct.
int	shadingRate()
VkCoarseSampleOrderCustomNV	shadingRate(int value)	Sets the specified value to the shadingRate field.
int	sizeof()	Returns sizeof(struct).
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface 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.

SHADINGRATE

public static final int SHADINGRATE

The struct member offsets.

SAMPLECOUNT

public static final int SAMPLECOUNT

The struct member offsets.

SAMPLELOCATIONCOUNT

public static final int SAMPLELOCATIONCOUNT

The struct member offsets.

PSAMPLELOCATIONS

public static final int PSAMPLELOCATIONS

The struct member offsets.

Constructor Details

VkCoarseSampleOrderCustomNV

public VkCoarseSampleOrderCustomNV(ByteBuffer container)

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

shadingRate

@NativeType("VkShadingRatePaletteEntryNV")
public int shadingRate()

Returns:

the value of the shadingRate field.

sampleCount

@NativeType("uint32_t")
public int sampleCount()

Returns:

the value of the sampleCount field.

sampleLocationCount

@NativeType("uint32_t")
public int sampleLocationCount()

Returns:

the value of the sampleLocationCount field.

pSampleLocations

@NativeType("VkCoarseSampleLocationNV const *")
public VkCoarseSampleLocationNV.Buffer pSampleLocations()

Returns:

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

shadingRate

public VkCoarseSampleOrderCustomNV shadingRate(@NativeType("VkShadingRatePaletteEntryNV")
 int value)

Sets the specified value to the shadingRate field.

sampleCount

public VkCoarseSampleOrderCustomNV sampleCount(@NativeType("uint32_t")
 int value)

Sets the specified value to the sampleCount field.

pSampleLocations

public VkCoarseSampleOrderCustomNV pSampleLocations(@NativeType("VkCoarseSampleLocationNV const *")
 VkCoarseSampleLocationNV.Buffer value)

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

set

public VkCoarseSampleOrderCustomNV set(int shadingRate,
 int sampleCount,
 VkCoarseSampleLocationNV.Buffer pSampleLocations)

Initializes this struct with the specified values.

set

public VkCoarseSampleOrderCustomNV set(VkCoarseSampleOrderCustomNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkCoarseSampleOrderCustomNV malloc()

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

calloc

public static VkCoarseSampleOrderCustomNV calloc()

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

create

public static VkCoarseSampleOrderCustomNV create()

Returns a new VkCoarseSampleOrderCustomNV instance allocated with BufferUtils.

create

public static VkCoarseSampleOrderCustomNV create(long address)

Returns a new VkCoarseSampleOrderCustomNV instance for the specified memory address.

createSafe

public static @Nullable VkCoarseSampleOrderCustomNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkCoarseSampleOrderCustomNV.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkCoarseSampleOrderCustomNV.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkCoarseSampleOrderCustomNV.Buffer create(int capacity)

Returns a new VkCoarseSampleOrderCustomNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkCoarseSampleOrderCustomNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkCoarseSampleOrderCustomNV malloc(MemoryStack stack)

Returns a new VkCoarseSampleOrderCustomNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkCoarseSampleOrderCustomNV calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nshadingRate

public static int nshadingRate(long struct)

Unsafe version of shadingRate().

nsampleCount

public static int nsampleCount(long struct)

Unsafe version of sampleCount().

nsampleLocationCount

public static int nsampleLocationCount(long struct)

Unsafe version of sampleLocationCount().

npSampleLocations

public static VkCoarseSampleLocationNV.Buffer npSampleLocations(long struct)

Unsafe version of pSampleLocations().

nshadingRate

public static void nshadingRate(long struct,
 int value)

Unsafe version of shadingRate.

nsampleCount

public static void nsampleCount(long struct,
 int value)

Unsafe version of sampleCount.

nsampleLocationCount

public static void nsampleLocationCount(long struct,
 int value)

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

npSampleLocations

public static void npSampleLocations(long struct,
 VkCoarseSampleLocationNV.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