Package org.lwjgl.vulkan
Class VkPipelineViewportCoarseSampleOrderStateCreateInfoNV
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkPipelineViewportCoarseSampleOrderStateCreateInfoNV
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkPipelineViewportCoarseSampleOrderStateCreateInfoNV extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Structure specifying parameters controlling sample order in coarse fragments.Description
If this structure is not present,
sampleOrderType
is considered to beCOARSE_SAMPLE_ORDER_TYPE_DEFAULT_NV
.If
sampleOrderType
isCOARSE_SAMPLE_ORDER_TYPE_CUSTOM_NV
, the coverage sample order used for any combination of fragment area and coverage sample count not enumerated inpCustomSampleOrders
will be identical to that used forCOARSE_SAMPLE_ORDER_TYPE_DEFAULT_NV
.If the pipeline was created with
DYNAMIC_STATE_VIEWPORT_COARSE_SAMPLE_ORDER_NV
, the contents of this structure (if present) are ignored, and the coverage sample order is instead specified byCmdSetCoarseSampleOrderNV
.Valid Usage
- If
sampleOrderType
is notCOARSE_SAMPLE_ORDER_TYPE_CUSTOM_NV
,customSamplerOrderCount
must be 0 - The array
pCustomSampleOrders
must not contain two structures with matching values for both theshadingRate
andsampleCount
members.
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_PIPELINE_VIEWPORT_COARSE_SAMPLE_ORDER_STATE_CREATE_INFO_NV
sampleOrderType
must be a validVkCoarseSampleOrderTypeNV
value- If
customSampleOrderCount
is not 0,pCustomSampleOrders
must be a valid pointer to an array ofcustomSampleOrderCount
validVkCoarseSampleOrderCustomNV
structures
See Also
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.sampleOrderType
– specifies the mechanism used to order coverage samples in fragments larger than one pixel.customSampleOrderCount
– specifies the number of custom sample orderings to use when ordering coverage samples.pCustomSampleOrders
– a pointer to an array ofVkCoarseSampleOrderCustomNV
structures, each of which specifies the coverage sample order for a single combination of fragment area and coverage sample count.
Layout
struct VkPipelineViewportCoarseSampleOrderStateCreateInfoNV { VkStructureType sType; void const * pNext; VkCoarseSampleOrderTypeNV sampleOrderType; uint32_t customSampleOrderCount;
VkCoarseSampleOrderCustomNV
const * pCustomSampleOrders; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer
An array ofVkPipelineViewportCoarseSampleOrderStateCreateInfoNV
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
CUSTOMSAMPLEORDERCOUNT
PCUSTOMSAMPLEORDERS
PNEXT
SAMPLEORDERTYPEThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STYPE
The struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkPipelineViewportCoarseSampleOrderStateCreateInfoNV(java.nio.ByteBuffer container)
Creates aVkPipelineViewportCoarseSampleOrderStateCreateInfoNV
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV
calloc()
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV
instance allocated withmemCalloc
.static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer
calloc(int capacity)
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer
instance allocated withmemCalloc
.static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV
callocStack()
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer
callocStack(int capacity)
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV
create()
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV
instance allocated withBufferUtils
.static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer
create(int capacity)
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer
instance allocated withBufferUtils
.static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV
create(long address)
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV
instance for the specified memory address.static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer
create(long address, int capacity)
Create aVkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer
instance at the specified memory.static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV
createSafe(long address)
static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer
createSafe(long address, int capacity)
int
customSampleOrderCount()
Returns the value of thecustomSampleOrderCount
field.static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV
malloc()
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV
instance allocated withmemAlloc
.static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer
malloc(int capacity)
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer
instance allocated withmemAlloc
.static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV
mallocStack()
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV
instance allocated on the thread-localMemoryStack
.static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer
mallocStack(int capacity)
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer
instance allocated on the thread-localMemoryStack
.static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer
instance allocated on the specifiedMemoryStack
.static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV
instance allocated on the specifiedMemoryStack
.static int
ncustomSampleOrderCount(long struct)
Unsafe version ofcustomSampleOrderCount()
.static void
ncustomSampleOrderCount(long struct, int value)
Sets the specified value to thecustomSampleOrderCount
field of the specifiedstruct
.static VkCoarseSampleOrderCustomNV.Buffer
npCustomSampleOrders(long struct)
Unsafe version ofpCustomSampleOrders()
.static void
npCustomSampleOrders(long struct, VkCoarseSampleOrderCustomNV.Buffer value)
Unsafe version ofpCustomSampleOrders
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static int
nsampleOrderType(long struct)
Unsafe version ofsampleOrderType()
.static void
nsampleOrderType(long struct, int value)
Unsafe version ofsampleOrderType
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.VkCoarseSampleOrderCustomNV.Buffer
pCustomSampleOrders()
Returns aVkCoarseSampleOrderCustomNV.Buffer
view of the struct array pointed to by thepCustomSampleOrders
field.VkPipelineViewportCoarseSampleOrderStateCreateInfoNV
pCustomSampleOrders(VkCoarseSampleOrderCustomNV.Buffer value)
Sets the address of the specifiedVkCoarseSampleOrderCustomNV.Buffer
to thepCustomSampleOrders
field.long
pNext()
Returns the value of thepNext
field.VkPipelineViewportCoarseSampleOrderStateCreateInfoNV
pNext(long value)
Sets the specified value to thepNext
field.int
sampleOrderType()
Returns the value of thesampleOrderType
field.VkPipelineViewportCoarseSampleOrderStateCreateInfoNV
sampleOrderType(int value)
Sets the specified value to thesampleOrderType
field.VkPipelineViewportCoarseSampleOrderStateCreateInfoNV
set(int sType, long pNext, int sampleOrderType, VkCoarseSampleOrderCustomNV.Buffer pCustomSampleOrders)
Initializes this struct with the specified values.VkPipelineViewportCoarseSampleOrderStateCreateInfoNV
set(VkPipelineViewportCoarseSampleOrderStateCreateInfoNV src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkPipelineViewportCoarseSampleOrderStateCreateInfoNV
sType(int value)
Sets the specified value to thesType
field.static void
validate(long struct)
Validates pointer members that should not beNULL
.static void
validate(long array, int count)
Callsvalidate(long)
for each struct contained in the specified struct array.
-
-
-
Constructor Detail
-
VkPipelineViewportCoarseSampleOrderStateCreateInfoNV
public VkPipelineViewportCoarseSampleOrderStateCreateInfoNV(java.nio.ByteBuffer container)
Creates aVkPipelineViewportCoarseSampleOrderStateCreateInfoNV
instance at the current position of the specifiedByteBuffer
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
-
sizeof
public int sizeof()
- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
sampleOrderType
public int sampleOrderType()
Returns the value of thesampleOrderType
field.
-
customSampleOrderCount
public int customSampleOrderCount()
Returns the value of thecustomSampleOrderCount
field.
-
pCustomSampleOrders
@Nullable public VkCoarseSampleOrderCustomNV.Buffer pCustomSampleOrders()
Returns aVkCoarseSampleOrderCustomNV.Buffer
view of the struct array pointed to by thepCustomSampleOrders
field.
-
sType
public VkPipelineViewportCoarseSampleOrderStateCreateInfoNV sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkPipelineViewportCoarseSampleOrderStateCreateInfoNV pNext(long value)
Sets the specified value to thepNext
field.
-
sampleOrderType
public VkPipelineViewportCoarseSampleOrderStateCreateInfoNV sampleOrderType(int value)
Sets the specified value to thesampleOrderType
field.
-
pCustomSampleOrders
public VkPipelineViewportCoarseSampleOrderStateCreateInfoNV pCustomSampleOrders(@Nullable VkCoarseSampleOrderCustomNV.Buffer value)
Sets the address of the specifiedVkCoarseSampleOrderCustomNV.Buffer
to thepCustomSampleOrders
field.
-
set
public VkPipelineViewportCoarseSampleOrderStateCreateInfoNV set(int sType, long pNext, int sampleOrderType, @Nullable VkCoarseSampleOrderCustomNV.Buffer pCustomSampleOrders)
Initializes this struct with the specified values.
-
set
public VkPipelineViewportCoarseSampleOrderStateCreateInfoNV set(VkPipelineViewportCoarseSampleOrderStateCreateInfoNV src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV malloc()
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV calloc()
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV create()
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV
instance allocated withBufferUtils
.
-
create
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV create(long address)
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV
instance for the specified memory address.
-
createSafe
@Nullable public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV createSafe(long address)
-
malloc
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer malloc(int capacity)
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer calloc(int capacity)
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer create(int capacity)
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer create(long address, int capacity)
Create aVkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV mallocStack()
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV callocStack()
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer mallocStack(int capacity)
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer callocStack(int capacity)
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineViewportCoarseSampleOrderStateCreateInfoNV.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType()
.
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext()
.
-
nsampleOrderType
public static int nsampleOrderType(long struct)
Unsafe version ofsampleOrderType()
.
-
ncustomSampleOrderCount
public static int ncustomSampleOrderCount(long struct)
Unsafe version ofcustomSampleOrderCount()
.
-
npCustomSampleOrders
@Nullable public static VkCoarseSampleOrderCustomNV.Buffer npCustomSampleOrders(long struct)
Unsafe version ofpCustomSampleOrders()
.
-
nsType
public static void nsType(long struct, int value)
Unsafe version ofsType
.
-
npNext
public static void npNext(long struct, long value)
Unsafe version ofpNext
.
-
nsampleOrderType
public static void nsampleOrderType(long struct, int value)
Unsafe version ofsampleOrderType
.
-
ncustomSampleOrderCount
public static void ncustomSampleOrderCount(long struct, int value)
Sets the specified value to thecustomSampleOrderCount
field of the specifiedstruct
.
-
npCustomSampleOrders
public static void npCustomSampleOrders(long struct, @Nullable VkCoarseSampleOrderCustomNV.Buffer value)
Unsafe version ofpCustomSampleOrders
.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL
.- Parameters:
struct
- the struct to validate
-
validate
public static void validate(long array, int count)
Callsvalidate(long)
for each struct contained in the specified struct array.- Parameters:
array
- the struct array to validatecount
- the number of structs inarray
-
-