Structure specifying parameters controlling shading rate image usage.

Description

The VkCoarseSampleOrderCustomNV structure is used with a coverage sample ordering type of COARSE_SAMPLE_ORDER_TYPE_CUSTOM_NV to specify the order of coverage samples for one combination of fragment width, fragment height, and coverage sample count.

When using a custom sample ordering, element j in pSampleLocations specifies a specific pixel location and sample index that corresponds to coverage index j in the multi-pixel fragment.

Valid Usage

shadingRate must be a shading rate that generates fragments with more than one pixel
sampleCount must correspond to a sample count enumerated in VkSampleCountFlags whose corresponding bit is set in VkPhysicalDeviceLimits::framebufferNoAttachmentsSampleCounts
sampleLocationCount must be equal to the product of sampleCount, the fragment width for shadingRate, and the fragment height for shadingRate
sampleLocationCount must be less than or equal to the value of VkPhysicalDeviceShadingRateImagePropertiesNV::shadingRateMaxCoarseSamples
The array pSampleLocations must contain exactly one entry for every combination of valid values for pixelX, pixelY, and sample in the structure VkCoarseSampleOrderCustomNV

Valid Usage (Implicit)

shadingRate must be a valid VkShadingRatePaletteEntryNV value
pSampleLocations must be a valid pointer to an array of sampleLocationCount VkCoarseSampleLocationNV structures
sampleLocationCount must be greater than 0

Layout


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

Nested and Inner Type Summary

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

Field Summary

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

Inherited from org.lwjgl.system.Struct:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	VkCoarseSampleOrderCustomNV(long address, ByteBuffer container)
public	VkCoarseSampleOrderCustomNV(ByteBuffer container) Creates a `VkCoarseSampleOrderCustomNV` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static VkCoarseSampleOrderCustomNV	calloc() Returns a new `VkCoarseSampleOrderCustomNV` instance allocated with `memCalloc`.
public static VkCoarseSampleOrderCustomNV.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkCoarseSampleOrderCustomNV.Buffer` instance allocated with `memCalloc`.
public static VkCoarseSampleOrderCustomNV	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkCoarseSampleOrderCustomNV` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkCoarseSampleOrderCustomNV.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkCoarseSampleOrderCustomNV.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkCoarseSampleOrderCustomNV	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkCoarseSampleOrderCustomNV	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkCoarseSampleOrderCustomNV.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkCoarseSampleOrderCustomNV.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkCoarseSampleOrderCustomNV	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Implements abstract org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public static VkCoarseSampleOrderCustomNV	create() Returns a new `VkCoarseSampleOrderCustomNV` instance allocated with `BufferUtils`.
public static VkCoarseSampleOrderCustomNV	create(long address) Returns a new `VkCoarseSampleOrderCustomNV` instance for the specified memory address.
public static VkCoarseSampleOrderCustomNV.Buffer	create(int the buffer capacity capacity) Returns a new `VkCoarseSampleOrderCustomNV.Buffer` instance allocated with `BufferUtils`.
public static VkCoarseSampleOrderCustomNV.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkCoarseSampleOrderCustomNV.Buffer` instance at the specified memory.
public static VkCoarseSampleOrderCustomNV	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkCoarseSampleOrderCustomNV.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static VkCoarseSampleOrderCustomNV	malloc() Returns a new `VkCoarseSampleOrderCustomNV` instance allocated with `memAlloc`.
public static VkCoarseSampleOrderCustomNV.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkCoarseSampleOrderCustomNV.Buffer` instance allocated with `memAlloc`.
public static VkCoarseSampleOrderCustomNV	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkCoarseSampleOrderCustomNV` instance allocated on the specified `MemoryStack`.
public static VkCoarseSampleOrderCustomNV.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkCoarseSampleOrderCustomNV.Buffer` instance allocated on the specified `MemoryStack`.
public static VkCoarseSampleOrderCustomNV	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkCoarseSampleOrderCustomNV	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkCoarseSampleOrderCustomNV.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkCoarseSampleOrderCustomNV.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkCoarseSampleLocationNV.Buffer	npSampleLocations(long struct) Unsafe version of `pSampleLocations`.
public static void	npSampleLocations(long struct, VkCoarseSampleLocationNV.Buffer value) Unsafe version of `pSampleLocations`.
public static int	nsampleCount(long struct) Unsafe version of `sampleCount`.
public static void	nsampleCount(long struct, int value) Unsafe version of `sampleCount`.
public static int	nsampleLocationCount(long struct) Unsafe version of `sampleLocationCount`.
public static void	nsampleLocationCount(long struct, int value) Sets the specified value to the `sampleLocationCount` field of the specified `struct`.
public static int	nshadingRate(long struct) Unsafe version of `shadingRate`.
public static void	nshadingRate(long struct, int value) Unsafe version of `shadingRate`.
public VkCoarseSampleLocationNV.Buffer	pSampleLocations() a pointer to an array of `VkCoarseSampleLocationNV` structures specifying the location of each sample in the custom ordering.
public VkCoarseSampleOrderCustomNV	pSampleLocations(VkCoarseSampleLocationNV.Buffer value) Sets the address of the specified `VkCoarseSampleLocationNV.Buffer` to the `pSampleLocations` field.
public int	sampleCount() identifies the per-pixel coverage sample count for the combination of fragment area and coverage sample count to control.
public VkCoarseSampleOrderCustomNV	sampleCount(int value) Sets the specified value to the `sampleCount` field.
public int	sampleLocationCount() specifies the number of sample locations in the custom ordering.
public VkCoarseSampleOrderCustomNV	set(int shadingRate, int sampleCount, VkCoarseSampleLocationNV.Buffer pSampleLocations) Initializes this struct with the specified values.
public VkCoarseSampleOrderCustomNV	Returns: this struct set(VkCoarseSampleOrderCustomNV the source struct src) Copies the specified struct data to this struct.
public int	shadingRate() a shading rate palette entry that identifies the fragment width and height for the combination of fragment area and per-pixel coverage sample count to control.
public VkCoarseSampleOrderCustomNV	shadingRate(int value) Sets the specified value to the `shadingRate` field.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public static void	validate(long the struct to validate struct) Validates pointer members that should not be `NULL`.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

PSAMPLELOCATIONS	back to summary
public static final int PSAMPLELOCATIONS The struct member offsets.

SAMPLECOUNT	back to summary
public static final int SAMPLECOUNT The struct member offsets.

SAMPLELOCATIONCOUNT	back to summary
public static final int SAMPLELOCATIONCOUNT The struct member offsets.

SHADINGRATE	back to summary
public static final int SHADINGRATE The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

Constructor Detail

VkCoarseSampleOrderCustomNV	back to summary
protected VkCoarseSampleOrderCustomNV(long address, ByteBuffer container)

VkCoarseSampleOrderCustomNV back to summary

VkCoarseSampleOrderCustomNV	back to summary
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.

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 Detail

calloc	back to summary
public static VkCoarseSampleOrderCustomNV calloc() Returns a new `VkCoarseSampleOrderCustomNV` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static VkCoarseSampleOrderCustomNV.Buffer calloc(int capacity) Returns a new `VkCoarseSampleOrderCustomNV.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkCoarseSampleOrderCustomNV.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
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:MemoryStack the stack from which to allocate

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:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
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:int the buffer capacity stack:MemoryStack the stack from which to allocate

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:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

callocStack back to summary

callocStack	back to summary
public static VkCoarseSampleOrderCustomNV callocStack() Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkCoarseSampleOrderCustomNV callocStack()

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkCoarseSampleOrderCustomNV callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkCoarseSampleOrderCustomNV callocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkCoarseSampleOrderCustomNV.Buffer callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkCoarseSampleOrderCustomNV.Buffer callocStack(int capacity)

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkCoarseSampleOrderCustomNV.Buffer callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

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

Deprecated

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

Annotations

@Deprecated

create back to summary

create	back to summary
protected VkCoarseSampleOrderCustomNV create(long address, ByteBuffer container) Implements abstract org.lwjgl.system.Struct.create. Doc from org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass. Effectively, every `Struct` instance is a factory for more instances of the same type. This is used by `StructBuffer`. Parameters address:long the struct memory address container:ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. Annotations @Override

protected VkCoarseSampleOrderCustomNV create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters

address:long: the struct memory address
container:ByteBuffer: an optional container buffer, to be referenced strongly by the struct instance.

Annotations

@Override

create	back to summary
public static VkCoarseSampleOrderCustomNV create() Returns a new `VkCoarseSampleOrderCustomNV` instance allocated with `BufferUtils`.

create	back to summary
public static VkCoarseSampleOrderCustomNV create(long address) Returns a new `VkCoarseSampleOrderCustomNV` instance for the specified memory address.

create back to summary

create	back to summary
public static VkCoarseSampleOrderCustomNV.Buffer create(int capacity) Returns a new `VkCoarseSampleOrderCustomNV.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static VkCoarseSampleOrderCustomNV.Buffer create(int capacity)

Returns a new VkCoarseSampleOrderCustomNV.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static VkCoarseSampleOrderCustomNV.Buffer create(long address, int capacity) Create a `VkCoarseSampleOrderCustomNV.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

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

Create a VkCoarseSampleOrderCustomNV.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static VkCoarseSampleOrderCustomNV createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkCoarseSampleOrderCustomNV createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static VkCoarseSampleOrderCustomNV.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

malloc	back to summary
public static VkCoarseSampleOrderCustomNV malloc() Returns a new `VkCoarseSampleOrderCustomNV` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static VkCoarseSampleOrderCustomNV.Buffer malloc(int capacity) Returns a new `VkCoarseSampleOrderCustomNV.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkCoarseSampleOrderCustomNV.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static VkCoarseSampleOrderCustomNV malloc(MemoryStack stack) Returns a new `VkCoarseSampleOrderCustomNV` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkCoarseSampleOrderCustomNV malloc(MemoryStack stack)

Returns a new VkCoarseSampleOrderCustomNV instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static VkCoarseSampleOrderCustomNV.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkCoarseSampleOrderCustomNV.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

mallocStack back to summary

mallocStack	back to summary
public static VkCoarseSampleOrderCustomNV mallocStack() Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkCoarseSampleOrderCustomNV mallocStack()

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkCoarseSampleOrderCustomNV mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkCoarseSampleOrderCustomNV mallocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkCoarseSampleOrderCustomNV.Buffer mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkCoarseSampleOrderCustomNV.Buffer mallocStack(int capacity)

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkCoarseSampleOrderCustomNV.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

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

Deprecated

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

Annotations

@Deprecated

npSampleLocations	back to summary
public static VkCoarseSampleLocationNV.Buffer npSampleLocations(long struct) Unsafe version of `pSampleLocations`.

npSampleLocations	back to summary
public static void npSampleLocations(long struct, VkCoarseSampleLocationNV.Buffer value) Unsafe version of `pSampleLocations`.

nsampleCount	back to summary
public static int nsampleCount(long struct) Unsafe version of `sampleCount`.

nsampleCount	back to summary
public static void nsampleCount(long struct, int value) Unsafe version of `sampleCount`.

nsampleLocationCount	back to summary
public static int nsampleLocationCount(long struct) Unsafe version of `sampleLocationCount`.

nsampleLocationCount	back to summary
public static void nsampleLocationCount(long struct, int value) Sets the specified value to the `sampleLocationCount` field of the specified `struct`.

nshadingRate	back to summary
public static int nshadingRate(long struct) Unsafe version of `shadingRate`.

nshadingRate	back to summary
public static void nshadingRate(long struct, int value) Unsafe version of `shadingRate`.

pSampleLocations back to summary

pSampleLocations	back to summary
public VkCoarseSampleLocationNV.Buffer pSampleLocations() a pointer to an array of `VkCoarseSampleLocationNV` structures specifying the location of each sample in the custom ordering. Annotations @NativeType:VkCoarseSampleLocationNV const *

public VkCoarseSampleLocationNV.Buffer pSampleLocations()

a pointer to an array of VkCoarseSampleLocationNV structures specifying the location of each sample in the custom ordering.

Annotations

@NativeType:VkCoarseSampleLocationNV const *

pSampleLocations	back to summary
public VkCoarseSampleOrderCustomNV pSampleLocations(VkCoarseSampleLocationNV.Buffer value) Sets the address of the specified `VkCoarseSampleLocationNV.Buffer` to the `pSampleLocations` field.

sampleCount	back to summary
public int sampleCount() identifies the per-pixel coverage sample count for the combination of fragment area and coverage sample count to control. Annotations @NativeType:uint32_t

sampleCount

back to summary

public int sampleCount()

identifies the per-pixel coverage sample count for the combination of fragment area and coverage sample count to control.

Annotations

@NativeType:uint32_t

sampleCount	back to summary
public VkCoarseSampleOrderCustomNV sampleCount(int value) Sets the specified value to the `sampleCount` field.

sampleLocationCount	back to summary
public int sampleLocationCount() specifies the number of sample locations in the custom ordering. Annotations @NativeType:uint32_t

sampleLocationCount

back to summary

public int sampleLocationCount()

specifies the number of sample locations in the custom ordering.

Annotations

@NativeType:uint32_t

set	back to summary
public VkCoarseSampleOrderCustomNV set(int shadingRate, int sampleCount, VkCoarseSampleLocationNV.Buffer pSampleLocations) Initializes this struct with the specified values.

set	back to summary
public VkCoarseSampleOrderCustomNV set(VkCoarseSampleOrderCustomNV src) Copies the specified struct data to this struct. Parameters src:VkCoarseSampleOrderCustomNV the source struct Returns:VkCoarseSampleOrderCustomNV this struct

set

back to summary

public VkCoarseSampleOrderCustomNV set(VkCoarseSampleOrderCustomNV src)

Copies the specified struct data to this struct.

Parameters

src:VkCoarseSampleOrderCustomNV: the source struct

Returns:VkCoarseSampleOrderCustomNV

this struct

shadingRate

back to summary

public int shadingRate()

a shading rate palette entry that identifies the fragment width and height for the combination of fragment area and per-pixel coverage sample count to control.

Annotations

@NativeType:VkShadingRatePaletteEntryNV

shadingRate	back to summary
public VkCoarseSampleOrderCustomNV shadingRate(int value) Sets the specified value to the `shadingRate` field.

sizeof back to summary

public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations

@Override

validate back to summary

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters

struct:long: the struct to validate

org.lwjgl.vulkan back to summary

public Class VkCoarseSampleOrderCustomNV.Buffer

Class Inheritance

extends StructBuffer<VkCoarseSampleOrderCustomNV, VkCoarseSampleOrderCustomNV.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.vulkan.VkCoarseSampleOrderCustomNV.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkCoarseSampleOrderCustomNV structs.

Field Summary

Modifier and Type	Field and Description
private static final VkCoarseSampleOrderCustomNV	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkCoarseSampleOrderCustomNV.Buffer` instance backed by the specified container.
public	Buffer(long address, int cap)
pack-priv	Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and Type	Method and Description
protected VkCoarseSampleOrderCustomNV	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public VkCoarseSampleLocationNV.Buffer	Returns: a `VkCoarseSampleLocationNV.Buffer` view of the struct array pointed to by the `VkCoarseSampleOrderCustomNV#pSampleLocations` field. pSampleLocations()
public VkCoarseSampleOrderCustomNV.Buffer	pSampleLocations(VkCoarseSampleLocationNV.Buffer value) Sets the address of the specified `VkCoarseSampleLocationNV.Buffer` to the `VkCoarseSampleOrderCustomNV#pSampleLocations` field.
public int	Returns: the value of the `VkCoarseSampleOrderCustomNV#sampleCount` field. sampleCount()
public VkCoarseSampleOrderCustomNV.Buffer	sampleCount(int value) Sets the specified value to the `VkCoarseSampleOrderCustomNV#sampleCount` field.
public int	Returns: the value of the `VkCoarseSampleOrderCustomNV#sampleLocationCount` field. sampleLocationCount()
protected VkCoarseSampleOrderCustomNV.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `VkCoarseSampleOrderCustomNV#shadingRate` field. shadingRate()
public VkCoarseSampleOrderCustomNV.Buffer	shadingRate(int value) Sets the specified value to the `VkCoarseSampleOrderCustomNV#shadingRate` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final VkCoarseSampleOrderCustomNV ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new VkCoarseSampleOrderCustomNV.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkCoarseSampleOrderCustomNV#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactory

back to summary

protected VkCoarseSampleOrderCustomNV getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations

@Override

pSampleLocations	back to summary
public VkCoarseSampleLocationNV.Buffer pSampleLocations() Returns:VkCoarseSampleLocationNV.Buffer a `VkCoarseSampleLocationNV.Buffer` view of the struct array pointed to by the `VkCoarseSampleOrderCustomNV#pSampleLocations` field. Annotations @NativeType:VkCoarseSampleLocationNV const *

pSampleLocations	back to summary
public VkCoarseSampleOrderCustomNV.Buffer pSampleLocations(VkCoarseSampleLocationNV.Buffer value) Sets the address of the specified `VkCoarseSampleLocationNV.Buffer` to the `VkCoarseSampleOrderCustomNV#pSampleLocations` field.

sampleCount	back to summary
public int sampleCount() Returns:int the value of the `VkCoarseSampleOrderCustomNV#sampleCount` field. Annotations @NativeType:uint32_t

sampleCount	back to summary
public VkCoarseSampleOrderCustomNV.Buffer sampleCount(int value) Sets the specified value to the `VkCoarseSampleOrderCustomNV#sampleCount` field.

sampleLocationCount	back to summary
public int sampleLocationCount() Returns:int the value of the `VkCoarseSampleOrderCustomNV#sampleLocationCount` field. Annotations @NativeType:uint32_t

self

back to summary

protected VkCoarseSampleOrderCustomNV.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations

@Override

shadingRate	back to summary
public int shadingRate() Returns:int the value of the `VkCoarseSampleOrderCustomNV#shadingRate` field. Annotations @NativeType:VkShadingRatePaletteEntryNV

shadingRate	back to summary
public VkCoarseSampleOrderCustomNV.Buffer shadingRate(int value) Sets the specified value to the `VkCoarseSampleOrderCustomNV#shadingRate` field.

public Class VkCoarseSampleOrderCustomNV

Description

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class VkCoarseSampleOrderCustomNV.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail