Package org.lwjgl.vulkan
Class VkPipelineViewportShadingRateImageStateCreateInfoNV
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkPipelineViewportShadingRateImageStateCreateInfoNV
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkPipelineViewportShadingRateImageStateCreateInfoNV extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Structure specifying parameters controlling shading rate image usage.Description
If this structure is not present,
shadingRateImageEnable
is considered to beFALSE
, and the shading rate image and palettes are not used.Valid Usage
- If the multiple viewports feature is not enabled,
viewportCount
must be 0 or 1 viewportCount
must be less than or equal toVkPhysicalDeviceLimits
::maxViewports
- If
shadingRateImageEnable
isTRUE
,viewportCount
must be equal to theviewportCount
member ofVkPipelineViewportStateCreateInfo
- If no element of the
pDynamicStates
member ofpDynamicState
isDYNAMIC_STATE_VIEWPORT_SHADING_RATE_PALETTE_NV
,pShadingRatePalettes
must be a valid pointer to an array ofviewportCount
VkShadingRatePaletteNV
structures
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_PIPELINE_VIEWPORT_SHADING_RATE_IMAGE_STATE_CREATE_INFO_NV
- If
viewportCount
is not 0, andpShadingRatePalettes
is notNULL
,pShadingRatePalettes
must be a valid pointer to an array ofviewportCount
validVkShadingRatePaletteNV
structures
See Also
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.shadingRateImageEnable
– specifies whether shading rate image and palettes are used during rasterization.viewportCount
– specifies the number of per-viewport palettes used to translate values stored in shading rate images.pShadingRatePalettes
– a pointer to an array ofVkShadingRatePaletteNV
structures defining the palette for each viewport. If the shading rate palette state is dynamic, this member is ignored.
Layout
struct VkPipelineViewportShadingRateImageStateCreateInfoNV { VkStructureType sType; void const * pNext; VkBool32 shadingRateImageEnable; uint32_t viewportCount;
VkShadingRatePaletteNV
const * pShadingRatePalettes; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer
An array ofVkPipelineViewportShadingRateImageStateCreateInfoNV
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
PNEXT
PSHADINGRATEPALETTES
SHADINGRATEIMAGEENABLEThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STYPE
VIEWPORTCOUNTThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkPipelineViewportShadingRateImageStateCreateInfoNV(java.nio.ByteBuffer container)
Creates aVkPipelineViewportShadingRateImageStateCreateInfoNV
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 VkPipelineViewportShadingRateImageStateCreateInfoNV
calloc()
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV
instance allocated withmemCalloc
.static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer
calloc(int capacity)
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer
instance allocated withmemCalloc
.static VkPipelineViewportShadingRateImageStateCreateInfoNV
callocStack()
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer
callocStack(int capacity)
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPipelineViewportShadingRateImageStateCreateInfoNV
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPipelineViewportShadingRateImageStateCreateInfoNV
create()
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV
instance allocated withBufferUtils
.static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer
create(int capacity)
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer
instance allocated withBufferUtils
.static VkPipelineViewportShadingRateImageStateCreateInfoNV
create(long address)
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV
instance for the specified memory address.static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer
create(long address, int capacity)
Create aVkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer
instance at the specified memory.static VkPipelineViewportShadingRateImageStateCreateInfoNV
createSafe(long address)
static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer
createSafe(long address, int capacity)
static VkPipelineViewportShadingRateImageStateCreateInfoNV
malloc()
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV
instance allocated withmemAlloc
.static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer
malloc(int capacity)
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer
instance allocated withmemAlloc
.static VkPipelineViewportShadingRateImageStateCreateInfoNV
mallocStack()
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV
instance allocated on the thread-localMemoryStack
.static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer
mallocStack(int capacity)
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer
instance allocated on the thread-localMemoryStack
.static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer
instance allocated on the specifiedMemoryStack
.static VkPipelineViewportShadingRateImageStateCreateInfoNV
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV
instance allocated on the specifiedMemoryStack
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static VkShadingRatePaletteNV.Buffer
npShadingRatePalettes(long struct)
Unsafe version ofpShadingRatePalettes()
.static void
npShadingRatePalettes(long struct, VkShadingRatePaletteNV.Buffer value)
Unsafe version ofpShadingRatePalettes
.static int
nshadingRateImageEnable(long struct)
Unsafe version ofshadingRateImageEnable()
.static void
nshadingRateImageEnable(long struct, int value)
Unsafe version ofshadingRateImageEnable
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.static int
nviewportCount(long struct)
Unsafe version ofviewportCount()
.static void
nviewportCount(long struct, int value)
Sets the specified value to theviewportCount
field of the specifiedstruct
.long
pNext()
Returns the value of thepNext
field.VkPipelineViewportShadingRateImageStateCreateInfoNV
pNext(long value)
Sets the specified value to thepNext
field.VkShadingRatePaletteNV.Buffer
pShadingRatePalettes()
Returns aVkShadingRatePaletteNV.Buffer
view of the struct array pointed to by thepShadingRatePalettes
field.VkPipelineViewportShadingRateImageStateCreateInfoNV
pShadingRatePalettes(VkShadingRatePaletteNV.Buffer value)
Sets the address of the specifiedVkShadingRatePaletteNV.Buffer
to thepShadingRatePalettes
field.VkPipelineViewportShadingRateImageStateCreateInfoNV
set(int sType, long pNext, boolean shadingRateImageEnable, int viewportCount, VkShadingRatePaletteNV.Buffer pShadingRatePalettes)
Initializes this struct with the specified values.VkPipelineViewportShadingRateImageStateCreateInfoNV
set(VkPipelineViewportShadingRateImageStateCreateInfoNV src)
Copies the specified struct data to this struct.boolean
shadingRateImageEnable()
Returns the value of theshadingRateImageEnable
field.VkPipelineViewportShadingRateImageStateCreateInfoNV
shadingRateImageEnable(boolean value)
Sets the specified value to theshadingRateImageEnable
field.int
sizeof()
int
sType()
Returns the value of thesType
field.VkPipelineViewportShadingRateImageStateCreateInfoNV
sType(int value)
Sets the specified value to thesType
field.int
viewportCount()
Returns the value of theviewportCount
field.VkPipelineViewportShadingRateImageStateCreateInfoNV
viewportCount(int value)
Sets the specified value to theviewportCount
field.
-
-
-
Constructor Detail
-
VkPipelineViewportShadingRateImageStateCreateInfoNV
public VkPipelineViewportShadingRateImageStateCreateInfoNV(java.nio.ByteBuffer container)
Creates aVkPipelineViewportShadingRateImageStateCreateInfoNV
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.
-
shadingRateImageEnable
public boolean shadingRateImageEnable()
Returns the value of theshadingRateImageEnable
field.
-
viewportCount
public int viewportCount()
Returns the value of theviewportCount
field.
-
pShadingRatePalettes
@Nullable public VkShadingRatePaletteNV.Buffer pShadingRatePalettes()
Returns aVkShadingRatePaletteNV.Buffer
view of the struct array pointed to by thepShadingRatePalettes
field.
-
sType
public VkPipelineViewportShadingRateImageStateCreateInfoNV sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkPipelineViewportShadingRateImageStateCreateInfoNV pNext(long value)
Sets the specified value to thepNext
field.
-
shadingRateImageEnable
public VkPipelineViewportShadingRateImageStateCreateInfoNV shadingRateImageEnable(boolean value)
Sets the specified value to theshadingRateImageEnable
field.
-
viewportCount
public VkPipelineViewportShadingRateImageStateCreateInfoNV viewportCount(int value)
Sets the specified value to theviewportCount
field.
-
pShadingRatePalettes
public VkPipelineViewportShadingRateImageStateCreateInfoNV pShadingRatePalettes(@Nullable VkShadingRatePaletteNV.Buffer value)
Sets the address of the specifiedVkShadingRatePaletteNV.Buffer
to thepShadingRatePalettes
field.
-
set
public VkPipelineViewportShadingRateImageStateCreateInfoNV set(int sType, long pNext, boolean shadingRateImageEnable, int viewportCount, @Nullable VkShadingRatePaletteNV.Buffer pShadingRatePalettes)
Initializes this struct with the specified values.
-
set
public VkPipelineViewportShadingRateImageStateCreateInfoNV set(VkPipelineViewportShadingRateImageStateCreateInfoNV src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkPipelineViewportShadingRateImageStateCreateInfoNV malloc()
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkPipelineViewportShadingRateImageStateCreateInfoNV calloc()
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkPipelineViewportShadingRateImageStateCreateInfoNV create()
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV
instance allocated withBufferUtils
.
-
create
public static VkPipelineViewportShadingRateImageStateCreateInfoNV create(long address)
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV
instance for the specified memory address.
-
createSafe
@Nullable public static VkPipelineViewportShadingRateImageStateCreateInfoNV createSafe(long address)
-
malloc
public static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer malloc(int capacity)
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer calloc(int capacity)
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer create(int capacity)
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer create(long address, int capacity)
Create aVkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkPipelineViewportShadingRateImageStateCreateInfoNV mallocStack()
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkPipelineViewportShadingRateImageStateCreateInfoNV callocStack()
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkPipelineViewportShadingRateImageStateCreateInfoNV mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkPipelineViewportShadingRateImageStateCreateInfoNV callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer mallocStack(int capacity)
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer callocStack(int capacity)
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkPipelineViewportShadingRateImageStateCreateInfoNV.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineViewportShadingRateImageStateCreateInfoNV.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()
.
-
nshadingRateImageEnable
public static int nshadingRateImageEnable(long struct)
Unsafe version ofshadingRateImageEnable()
.
-
nviewportCount
public static int nviewportCount(long struct)
Unsafe version ofviewportCount()
.
-
npShadingRatePalettes
@Nullable public static VkShadingRatePaletteNV.Buffer npShadingRatePalettes(long struct)
Unsafe version ofpShadingRatePalettes()
.
-
nsType
public static void nsType(long struct, int value)
Unsafe version ofsType
.
-
npNext
public static void npNext(long struct, long value)
Unsafe version ofpNext
.
-
nshadingRateImageEnable
public static void nshadingRateImageEnable(long struct, int value)
Unsafe version ofshadingRateImageEnable
.
-
nviewportCount
public static void nviewportCount(long struct, int value)
Sets the specified value to theviewportCount
field of the specifiedstruct
.
-
npShadingRatePalettes
public static void npShadingRatePalettes(long struct, @Nullable VkShadingRatePaletteNV.Buffer value)
Unsafe version ofpShadingRatePalettes
.
-
-