Package org.lwjgl.vulkan
Class VkRenderingFragmentShadingRateAttachmentInfoKHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkRenderingFragmentShadingRateAttachmentInfoKHR
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkRenderingFragmentShadingRateAttachmentInfoKHR extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying fragment shading rate attachment information.Description
This structure can be included in the
pNextchain ofVkRenderingInfoto define a fragment shading rate attachment. IfimageViewisNULL_HANDLE, or if this structure is not specified, the implementation behaves as if a valid shading rate attachment was specified with all texels specifying a single pixel per fragment.Valid Usage
- If
imageViewis notNULL_HANDLE,layoutmust beIMAGE_LAYOUT_GENERALorIMAGE_LAYOUT_FRAGMENT_SHADING_RATE_ATTACHMENT_OPTIMAL_KHR - If
imageViewis notNULL_HANDLE, it must have been created withIMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR - If
imageViewis notNULL_HANDLE,shadingRateAttachmentTexelSize.widthmust be a power of two value - If
imageViewis notNULL_HANDLE,shadingRateAttachmentTexelSize.widthmust be less than or equal tomaxFragmentShadingRateAttachmentTexelSize.width - If
imageViewis notNULL_HANDLE,shadingRateAttachmentTexelSize.widthmust be greater than or equal tominFragmentShadingRateAttachmentTexelSize.width - If
imageViewis notNULL_HANDLE,shadingRateAttachmentTexelSize.heightmust be a power of two value - If
imageViewis notNULL_HANDLE,shadingRateAttachmentTexelSize.heightmust be less than or equal tomaxFragmentShadingRateAttachmentTexelSize.height - If
imageViewis notNULL_HANDLE,shadingRateAttachmentTexelSize.heightmust be greater than or equal tominFragmentShadingRateAttachmentTexelSize.height - If
imageViewis notNULL_HANDLE, the quotient ofshadingRateAttachmentTexelSize.widthandshadingRateAttachmentTexelSize.heightmust be less than or equal tomaxFragmentShadingRateAttachmentTexelSizeAspectRatio - If
imageViewis notNULL_HANDLE, the quotient ofshadingRateAttachmentTexelSize.heightandshadingRateAttachmentTexelSize.widthmust be less than or equal tomaxFragmentShadingRateAttachmentTexelSizeAspectRatio
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_RENDERING_FRAGMENT_SHADING_RATE_ATTACHMENT_INFO_KHR- If
imageViewis notNULL_HANDLE,imageViewmust be a validVkImageViewhandle imageLayoutmust be a validVkImageLayoutvalue
See Also
Layout
struct VkRenderingFragmentShadingRateAttachmentInfoKHR { VkStructureTypesType(); void const *pNext(); VkImageViewimageView(); VkImageLayoutimageLayout();VkExtent2DshadingRateAttachmentTexelSize(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkRenderingFragmentShadingRateAttachmentInfoKHR.BufferAn array ofVkRenderingFragmentShadingRateAttachmentInfoKHRstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intIMAGELAYOUT
IMAGEVIEW
PNEXT
SHADINGRATEATTACHMENTTEXELSIZEThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkRenderingFragmentShadingRateAttachmentInfoKHR(java.nio.ByteBuffer container)Creates aVkRenderingFragmentShadingRateAttachmentInfoKHRinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkRenderingFragmentShadingRateAttachmentInfoKHRcalloc()Returns a newVkRenderingFragmentShadingRateAttachmentInfoKHRinstance allocated withmemCalloc.static VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffercalloc(int capacity)Returns a newVkRenderingFragmentShadingRateAttachmentInfoKHR.Bufferinstance allocated withmemCalloc.static VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkRenderingFragmentShadingRateAttachmentInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkRenderingFragmentShadingRateAttachmentInfoKHRcalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkRenderingFragmentShadingRateAttachmentInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkRenderingFragmentShadingRateAttachmentInfoKHRcreate()Returns a newVkRenderingFragmentShadingRateAttachmentInfoKHRinstance allocated withBufferUtils.static VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffercreate(int capacity)Returns a newVkRenderingFragmentShadingRateAttachmentInfoKHR.Bufferinstance allocated withBufferUtils.static VkRenderingFragmentShadingRateAttachmentInfoKHRcreate(long address)Returns a newVkRenderingFragmentShadingRateAttachmentInfoKHRinstance for the specified memory address.static VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffercreate(long address, int capacity)Create aVkRenderingFragmentShadingRateAttachmentInfoKHR.Bufferinstance at the specified memory.static VkRenderingFragmentShadingRateAttachmentInfoKHRcreateSafe(long address)static VkRenderingFragmentShadingRateAttachmentInfoKHR.BuffercreateSafe(long address, int capacity)intimageLayout()the layout thatimageViewwill be in during rendering.VkRenderingFragmentShadingRateAttachmentInfoKHRimageLayout(int value)Sets the specified value to theimageLayout()field.longimageView()the image view that will be used as a fragment shading rate attachment.VkRenderingFragmentShadingRateAttachmentInfoKHRimageView(long value)Sets the specified value to theimageView()field.static VkRenderingFragmentShadingRateAttachmentInfoKHRmalloc()Returns a newVkRenderingFragmentShadingRateAttachmentInfoKHRinstance allocated withmemAlloc.static VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffermalloc(int capacity)Returns a newVkRenderingFragmentShadingRateAttachmentInfoKHR.Bufferinstance allocated withmemAlloc.static VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkRenderingFragmentShadingRateAttachmentInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.static VkRenderingFragmentShadingRateAttachmentInfoKHRmalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkRenderingFragmentShadingRateAttachmentInfoKHRinstance allocated on the specifiedMemoryStack.static intnimageLayout(long struct)Unsafe version ofimageLayout().static voidnimageLayout(long struct, int value)Unsafe version ofimageLayout.static longnimageView(long struct)Unsafe version ofimageView().static voidnimageView(long struct, long value)Unsafe version ofimageView.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static VkExtent2DnshadingRateAttachmentTexelSize(long struct)Unsafe version ofshadingRateAttachmentTexelSize().static voidnshadingRateAttachmentTexelSize(long struct, VkExtent2D value)Unsafe version ofshadingRateAttachmentTexelSize.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.longpNext()NULLor a pointer to a structure extending this structure.VkRenderingFragmentShadingRateAttachmentInfoKHRpNext(long value)Sets the specified value to thepNext()field.VkRenderingFragmentShadingRateAttachmentInfoKHRset(int sType, long pNext, long imageView, int imageLayout, VkExtent2D shadingRateAttachmentTexelSize)Initializes this struct with the specified values.VkRenderingFragmentShadingRateAttachmentInfoKHRset(VkRenderingFragmentShadingRateAttachmentInfoKHR src)Copies the specified struct data to this struct.VkExtent2DshadingRateAttachmentTexelSize()specifies the number of pixels corresponding to each texel inimageView.VkRenderingFragmentShadingRateAttachmentInfoKHRshadingRateAttachmentTexelSize(java.util.function.Consumer<VkExtent2D> consumer)Passes theshadingRateAttachmentTexelSize()field to the specifiedConsumer.VkRenderingFragmentShadingRateAttachmentInfoKHRshadingRateAttachmentTexelSize(VkExtent2D value)Copies the specifiedVkExtent2Dto theshadingRateAttachmentTexelSize()field.intsizeof()intsType()the type of this structure.VkRenderingFragmentShadingRateAttachmentInfoKHRsType(int value)Sets the specified value to thesType()field.VkRenderingFragmentShadingRateAttachmentInfoKHRsType$Default()Sets theSTRUCTURE_TYPE_RENDERING_FRAGMENT_SHADING_RATE_ATTACHMENT_INFO_KHRvalue to thesType()field.
-
-
-
Constructor Detail
-
VkRenderingFragmentShadingRateAttachmentInfoKHR
public VkRenderingFragmentShadingRateAttachmentInfoKHR(java.nio.ByteBuffer container)
Creates aVkRenderingFragmentShadingRateAttachmentInfoKHRinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
the type of this structure.
-
pNext
public long pNext()
NULLor a pointer to a structure extending this structure.
-
imageView
public long imageView()
the image view that will be used as a fragment shading rate attachment.
-
imageLayout
public int imageLayout()
the layout thatimageViewwill be in during rendering.
-
shadingRateAttachmentTexelSize
public VkExtent2D shadingRateAttachmentTexelSize()
specifies the number of pixels corresponding to each texel inimageView.
-
sType
public VkRenderingFragmentShadingRateAttachmentInfoKHR sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkRenderingFragmentShadingRateAttachmentInfoKHR sType$Default()
Sets theSTRUCTURE_TYPE_RENDERING_FRAGMENT_SHADING_RATE_ATTACHMENT_INFO_KHRvalue to thesType()field.
-
pNext
public VkRenderingFragmentShadingRateAttachmentInfoKHR pNext(long value)
Sets the specified value to thepNext()field.
-
imageView
public VkRenderingFragmentShadingRateAttachmentInfoKHR imageView(long value)
Sets the specified value to theimageView()field.
-
imageLayout
public VkRenderingFragmentShadingRateAttachmentInfoKHR imageLayout(int value)
Sets the specified value to theimageLayout()field.
-
shadingRateAttachmentTexelSize
public VkRenderingFragmentShadingRateAttachmentInfoKHR shadingRateAttachmentTexelSize(VkExtent2D value)
Copies the specifiedVkExtent2Dto theshadingRateAttachmentTexelSize()field.
-
shadingRateAttachmentTexelSize
public VkRenderingFragmentShadingRateAttachmentInfoKHR shadingRateAttachmentTexelSize(java.util.function.Consumer<VkExtent2D> consumer)
Passes theshadingRateAttachmentTexelSize()field to the specifiedConsumer.
-
set
public VkRenderingFragmentShadingRateAttachmentInfoKHR set(int sType, long pNext, long imageView, int imageLayout, VkExtent2D shadingRateAttachmentTexelSize)
Initializes this struct with the specified values.
-
set
public VkRenderingFragmentShadingRateAttachmentInfoKHR set(VkRenderingFragmentShadingRateAttachmentInfoKHR src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkRenderingFragmentShadingRateAttachmentInfoKHR malloc()
Returns a newVkRenderingFragmentShadingRateAttachmentInfoKHRinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkRenderingFragmentShadingRateAttachmentInfoKHR calloc()
Returns a newVkRenderingFragmentShadingRateAttachmentInfoKHRinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkRenderingFragmentShadingRateAttachmentInfoKHR create()
Returns a newVkRenderingFragmentShadingRateAttachmentInfoKHRinstance allocated withBufferUtils.
-
create
public static VkRenderingFragmentShadingRateAttachmentInfoKHR create(long address)
Returns a newVkRenderingFragmentShadingRateAttachmentInfoKHRinstance for the specified memory address.
-
createSafe
@Nullable public static VkRenderingFragmentShadingRateAttachmentInfoKHR createSafe(long address)
-
malloc
public static VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer malloc(int capacity)
Returns a newVkRenderingFragmentShadingRateAttachmentInfoKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer calloc(int capacity)
Returns a newVkRenderingFragmentShadingRateAttachmentInfoKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer create(int capacity)
Returns a newVkRenderingFragmentShadingRateAttachmentInfoKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer create(long address, int capacity)
Create aVkRenderingFragmentShadingRateAttachmentInfoKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer createSafe(long address, int capacity)
-
malloc
public static VkRenderingFragmentShadingRateAttachmentInfoKHR malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkRenderingFragmentShadingRateAttachmentInfoKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkRenderingFragmentShadingRateAttachmentInfoKHR calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkRenderingFragmentShadingRateAttachmentInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkRenderingFragmentShadingRateAttachmentInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkRenderingFragmentShadingRateAttachmentInfoKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkRenderingFragmentShadingRateAttachmentInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand 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().
-
nimageView
public static long nimageView(long struct)
Unsafe version ofimageView().
-
nimageLayout
public static int nimageLayout(long struct)
Unsafe version ofimageLayout().
-
nshadingRateAttachmentTexelSize
public static VkExtent2D nshadingRateAttachmentTexelSize(long struct)
Unsafe version ofshadingRateAttachmentTexelSize().
-
nsType
public static void nsType(long struct, int value)Unsafe version ofsType.
-
npNext
public static void npNext(long struct, long value)Unsafe version ofpNext.
-
nimageView
public static void nimageView(long struct, long value)Unsafe version ofimageView.
-
nimageLayout
public static void nimageLayout(long struct, int value)Unsafe version ofimageLayout.
-
nshadingRateAttachmentTexelSize
public static void nshadingRateAttachmentTexelSize(long struct, VkExtent2D value)Unsafe version ofshadingRateAttachmentTexelSize.
-
-