Class VkSampleLocationsInfoEXT

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer

    public class VkSampleLocationsInfoEXT
    extends Struct
    implements NativeResource
    Structure specifying a set of sample locations.
    Description

    This structure can be used either to specify the sample locations to be used for rendering or to specify the set of sample locations an image subresource has been last rendered with for the purposes of layout transitions of depth/stencil images created with IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT.

    The sample locations in pSampleLocations specify sampleLocationsPerPixel number of sample locations for each pixel in the grid of the size specified in sampleLocationGridSize. The sample location for sample i at the pixel grid location (x,y) is taken from pSampleLocations[(x + y sampleLocationGridSize.width) sampleLocationsPerPixel + i].

    If the render pass has a fragment density map, the implementation will choose the sample locations for the fragment and the contents of pSampleLocations may be ignored.

    Valid Usage
    • sampleLocationsPerPixel must be a bit value that is set in VkPhysicalDeviceSampleLocationsPropertiesEXT::sampleLocationSampleCounts
    • sampleLocationsCount must equal sampleLocationsPerPixel × sampleLocationGridSize.width × sampleLocationGridSize.height
    Valid Usage (Implicit)
    • sType must be STRUCTURE_TYPE_SAMPLE_LOCATIONS_INFO_EXT
    • If sampleLocationsPerPixel is not 0, sampleLocationsPerPixel must be a valid VkSampleCountFlagBits value
    • If sampleLocationsCount is not 0, pSampleLocations must be a valid pointer to an array of sampleLocationsCount VkSampleLocationEXT structures
    See Also

    VkAttachmentSampleLocationsEXT, VkExtent2D, VkPipelineSampleLocationsStateCreateInfoEXT, VkSampleLocationEXT, VkSubpassSampleLocationsEXT, CmdSetSampleLocationsEXT

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • sampleLocationsPerPixel – a VkSampleCountFlagBits specifying the number of sample locations per pixel.
    • sampleLocationGridSize – the size of the sample location grid to select custom sample locations for.
    • sampleLocationsCount – the number of sample locations in pSampleLocations.
    • pSampleLocations – an array of sampleLocationsCount VkSampleLocationEXT structures.

    Layout

    
     struct VkSampleLocationsInfoEXT {
         VkStructureType sType;
         void const * pNext;
         VkSampleCountFlagBits sampleLocationsPerPixel;
         VkExtent2D sampleLocationGridSize;
         uint32_t sampleLocationsCount;
         VkSampleLocationEXT const * pSampleLocations;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, SAMPLELOCATIONSPERPIXEL, SAMPLELOCATIONGRIDSIZE, SAMPLELOCATIONSCOUNT, PSAMPLELOCATIONS

        The struct member offsets.
    • Constructor Detail

      • VkSampleLocationsInfoEXT

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