Package org.lwjgl.vulkan

Class VkCoarseSampleLocationNV

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
    public class VkCoarseSampleLocationNV
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
    Structure specifying parameters controlling shading rate image usage.
    Valid Usage
    • pixelX must be less than the width (in pixels) of the fragment
    • pixelY must be less than the height (in pixels) of the fragment
    • sample must be less than the number of coverage samples in each pixel belonging to the fragment
    See Also

    VkCoarseSampleOrderCustomNV

    Layout

    
 struct VkCoarseSampleLocationNV {
     uint32_t pixelX();
     uint32_t pixelY();
     uint32_t sample();
 }

    • Field Detail

      • SIZEOF

        The struct size in bytes.

      • ALIGNOF

        The struct alignment in bytes.

      • PIXELX, PIXELY, SAMPLE

        The struct member offsets.

    • Constructor Detail

      • VkCoarseSampleLocationNV

        public VkCoarseSampleLocationNV​(java.nio.ByteBuffer container)
        Creates a VkCoarseSampleLocationNV 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

      • sizeof

        public int sizeof()
        Specified by:
        sizeof in class org.lwjgl.system.Struct

      • pixelX

        public int pixelX()
        added to the x coordinate of the upper-leftmost pixel of each fragment to identify the pixel containing the coverage sample.

      • pixelY

        public int pixelY()
        added to the y coordinate of the upper-leftmost pixel of each fragment to identify the pixel containing the coverage sample.

      • sample

        public int sample()
        the number of the coverage sample in the pixel identified by pixelX and pixelY.

      • set

        public VkCoarseSampleLocationNV set​(int pixelX,
                                    int pixelY,
                                    int sample)
        Initializes this struct with the specified values.

      • malloc

        public static VkCoarseSampleLocationNV malloc()
        Returns a new VkCoarseSampleLocationNV instance allocated with memAlloc. The instance must be explicitly freed.

      • calloc

        public static VkCoarseSampleLocationNV calloc()
        Returns a new VkCoarseSampleLocationNV instance allocated with memCalloc. The instance must be explicitly freed.

      • create

        public static VkCoarseSampleLocationNV create()
        Returns a new VkCoarseSampleLocationNV instance allocated with BufferUtils.

      • create

        public static VkCoarseSampleLocationNV create​(long address)
        Returns a new VkCoarseSampleLocationNV instance for the specified memory address.

      • malloc

        public static VkCoarseSampleLocationNV malloc​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkCoarseSampleLocationNV instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate

      • calloc

        public static VkCoarseSampleLocationNV calloc​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkCoarseSampleLocationNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate

      • calloc

        public static VkCoarseSampleLocationNV.Buffer calloc​(int capacity,
                                                     org.lwjgl.system.MemoryStack stack)
        Returns a new VkCoarseSampleLocationNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity

      • npixelX

        public static int npixelX​(long struct)
        Unsafe version of pixelX().

      • npixelY

        public static int npixelY​(long struct)
        Unsafe version of pixelY().

      • nsample

        public static int nsample​(long struct)
        Unsafe version of sample().

      • npixelX

        public static void npixelX​(long struct,
                           int value)
        Unsafe version of pixelX.

      • npixelY

        public static void npixelY​(long struct,
                           int value)
        Unsafe version of pixelY.

      • nsample

        public static void nsample​(long struct,
                           int value)
        Unsafe version of sample.