Package org.lwjgl.vulkan

Class VkSampleLocationEXT

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkSampleLocationEXT>
org.lwjgl.vulkan.VkSampleLocationEXT
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkSampleLocationEXT extends org.lwjgl.system.Struct<VkSampleLocationEXT> implements org.lwjgl.system.NativeResource
Structure specifying the coordinates of a sample location.
Description

The domain space of the sample location coordinates has an upper-left origin within the pixel in framebuffer space.

The values specified in a VkSampleLocationEXT structure are always clamped to the implementation-dependent sample location coordinate range [sampleLocationCoordinateRange[0],sampleLocationCoordinateRange[1]] that can be queried using VkPhysicalDeviceSampleLocationsPropertiesEXT.

See Also

VkSampleLocationsInfoEXT

Layout


 struct VkSampleLocationEXT {
     float x();
     float y();
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • X

      public static final int X
      The struct member offsets.

    • Y

      public static final int Y
      The struct member offsets.

  • Constructor Details

    • VkSampleLocationEXT

      public VkSampleLocationEXT(ByteBuffer container)
      Creates a VkSampleLocationEXT 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 Details

    • sizeof

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

    • x

      public float x()
      the horizontal coordinate of the sample’s location.

    • y

      public float y()
      the vertical coordinate of the sample’s location.

    • x

      public VkSampleLocationEXT x(float value)
      Sets the specified value to the x() field.

    • y

      public VkSampleLocationEXT y(float value)
      Sets the specified value to the y() field.

    • set

      public VkSampleLocationEXT set(float x, float y)
      Initializes this struct with the specified values.

    • set

      public VkSampleLocationEXT set(VkSampleLocationEXT src)
      Copies the specified struct data to this struct.
      Parameters:
      src - the source struct
      Returns:
      this struct

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

      public static @Nullable VkSampleLocationEXT createSafe(long address)
      Like create, but returns null if address is NULL.

    • malloc

      public static VkSampleLocationEXT.Buffer malloc(int capacity)
      Returns a new VkSampleLocationEXT.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • calloc

      public static VkSampleLocationEXT.Buffer calloc(int capacity)
      Returns a new VkSampleLocationEXT.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VkSampleLocationEXT.Buffer create(int capacity)
      Returns a new VkSampleLocationEXT.Buffer instance allocated with BufferUtils.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VkSampleLocationEXT.Buffer create(long address, int capacity)
      Create a VkSampleLocationEXT.Buffer instance at the specified memory.
      Parameters:
      address - the memory address
      capacity - the buffer capacity

    • createSafe

      public static @Nullable VkSampleLocationEXT.Buffer createSafe(long address, int capacity)
      Like create, but returns null if address is NULL.

    • mallocStack

      @Deprecated public static VkSampleLocationEXT mallocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static VkSampleLocationEXT callocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

    • mallocStack

      @Deprecated public static VkSampleLocationEXT mallocStack(org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static VkSampleLocationEXT callocStack(org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

    • mallocStack

      @Deprecated public static VkSampleLocationEXT.Buffer mallocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

    • callocStack

      @Deprecated public static VkSampleLocationEXT.Buffer callocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

    • mallocStack

      @Deprecated public static VkSampleLocationEXT.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

    • callocStack

      @Deprecated public static VkSampleLocationEXT.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

    • malloc

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

    • calloc

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

    • malloc

      public static VkSampleLocationEXT.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new VkSampleLocationEXT.Buffer instance allocated on the specified MemoryStack.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • calloc

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

    • nx

      public static float nx(long struct)
      Unsafe version of x().

    • ny

      public static float ny(long struct)
      Unsafe version of y().

    • nx

      public static void nx(long struct, float value)
      Unsafe version of x.

    • ny

      public static void ny(long struct, float value)
      Unsafe version of y.