Class VkSampleLocationsInfoEXT
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
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
sampleLocationsPerPixelmust be a validVkSampleCountFlagBitsvalue that is set inVkPhysicalDeviceSampleLocationsPropertiesEXT::sampleLocationSampleCountssampleLocationsCountmust equalsampleLocationsPerPixel × sampleLocationGridSize.width × sampleLocationGridSize.height
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_SAMPLE_LOCATIONS_INFO_EXT- If
sampleLocationsCountis not 0,pSampleLocationsmust be a valid pointer to an array ofsampleLocationsCountVkSampleLocationEXTstructures
See Also
VkAttachmentSampleLocationsEXT, VkExtent2D, VkPipelineSampleLocationsStateCreateInfoEXT, VkSampleLocationEXT, VkSubpassSampleLocationsEXT, CmdSetSampleLocationsEXT
Layout
struct VkSampleLocationsInfoEXT {
VkStructureType sType();
void const * pNext();
VkSampleCountFlagBits sampleLocationsPerPixel();
VkExtent2D sampleLocationGridSize();
uint32_t sampleLocationsCount();
VkSampleLocationEXT const * pSampleLocations();
}-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkSampleLocationsInfoEXT(ByteBuffer container) Creates aVkSampleLocationsInfoEXTinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkSampleLocationsInfoEXTcalloc()Returns a newVkSampleLocationsInfoEXTinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkSampleLocationsInfoEXT.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkSampleLocationsInfoEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkSampleLocationsInfoEXTcalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkSampleLocationsInfoEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkSampleLocationsInfoEXTDeprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkSampleLocationsInfoEXTcallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static VkSampleLocationsInfoEXTcreate()Returns a newVkSampleLocationsInfoEXTinstance allocated withBufferUtils.create(int capacity) Returns a newVkSampleLocationsInfoEXT.Bufferinstance allocated withBufferUtils.static VkSampleLocationsInfoEXTcreate(long address) Returns a newVkSampleLocationsInfoEXTinstance for the specified memory address.create(long address, int capacity) Create aVkSampleLocationsInfoEXT.Bufferinstance at the specified memory.static @Nullable VkSampleLocationsInfoEXTcreateSafe(long address) static @Nullable VkSampleLocationsInfoEXT.BuffercreateSafe(long address, int capacity) static VkSampleLocationsInfoEXTmalloc()Returns a newVkSampleLocationsInfoEXTinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkSampleLocationsInfoEXT.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkSampleLocationsInfoEXT.Bufferinstance allocated on the specifiedMemoryStack.static VkSampleLocationsInfoEXTmalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkSampleLocationsInfoEXTinstance allocated on the specifiedMemoryStack.static VkSampleLocationsInfoEXTDeprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkSampleLocationsInfoEXTmallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static @Nullable VkSampleLocationEXT.BuffernpSampleLocations(long struct) Unsafe version ofpSampleLocations().static voidnpSampleLocations(long struct, @Nullable VkSampleLocationEXT.Buffer value) Unsafe version ofpSampleLocations.static VkExtent2DnsampleLocationGridSize(long struct) Unsafe version ofsampleLocationGridSize().static voidnsampleLocationGridSize(long struct, VkExtent2D value) Unsafe version ofsampleLocationGridSize.static intnsampleLocationsCount(long struct) Unsafe version ofsampleLocationsCount().static voidnsampleLocationsCount(long struct, int value) Sets the specified value to thesampleLocationsCountfield of the specifiedstruct.static intnsampleLocationsPerPixel(long struct) Unsafe version ofsampleLocationsPerPixel().static voidnsampleLocationsPerPixel(long struct, int value) Unsafe version ofsampleLocationsPerPixel.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.pNext(long value) Sets the specified value to thepNext()field.@Nullable VkSampleLocationEXT.Buffera pointer to an array ofsampleLocationsCountVkSampleLocationEXTstructures.pSampleLocations(@Nullable VkSampleLocationEXT.Buffer value) Sets the address of the specifiedVkSampleLocationEXT.Bufferto thepSampleLocations()field.the size of the sample location grid to select custom sample locations for.sampleLocationGridSize(Consumer<VkExtent2D> consumer) Passes thesampleLocationGridSize()field to the specifiedConsumer.sampleLocationGridSize(VkExtent2D value) Copies the specifiedVkExtent2Dto thesampleLocationGridSize()field.intthe number of sample locations inpSampleLocations.intaVkSampleCountFlagBitsvalue specifying the number of sample locations per pixel.sampleLocationsPerPixel(int value) Sets the specified value to thesampleLocationsPerPixel()field.set(int sType, long pNext, int sampleLocationsPerPixel, VkExtent2D sampleLocationGridSize, @Nullable VkSampleLocationEXT.Buffer pSampleLocations) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_SAMPLE_LOCATIONS_INFO_EXTvalue to thesType()field.static voidvalidate(long struct) Validates pointer members that should not beNULL.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
SAMPLELOCATIONSPERPIXEL
public static final int SAMPLELOCATIONSPERPIXELThe struct member offsets. -
SAMPLELOCATIONGRIDSIZE
public static final int SAMPLELOCATIONGRIDSIZEThe struct member offsets. -
SAMPLELOCATIONSCOUNT
public static final int SAMPLELOCATIONSCOUNTThe struct member offsets. -
PSAMPLELOCATIONS
public static final int PSAMPLELOCATIONSThe struct member offsets.
-
-
Constructor Details
-
VkSampleLocationsInfoEXT
Creates aVkSampleLocationsInfoEXTinstance 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 Details
-
sizeof
public int sizeof()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkSampleLocationsInfoEXT>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
sampleLocationsPerPixel
public int sampleLocationsPerPixel()aVkSampleCountFlagBitsvalue specifying the number of sample locations per pixel. -
sampleLocationGridSize
the size of the sample location grid to select custom sample locations for. -
sampleLocationsCount
public int sampleLocationsCount()the number of sample locations inpSampleLocations. -
pSampleLocations
a pointer to an array ofsampleLocationsCountVkSampleLocationEXTstructures. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_SAMPLE_LOCATIONS_INFO_EXTvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
sampleLocationsPerPixel
Sets the specified value to thesampleLocationsPerPixel()field. -
sampleLocationGridSize
Copies the specifiedVkExtent2Dto thesampleLocationGridSize()field. -
sampleLocationGridSize
Passes thesampleLocationGridSize()field to the specifiedConsumer. -
pSampleLocations
Sets the address of the specifiedVkSampleLocationEXT.Bufferto thepSampleLocations()field. -
set
public VkSampleLocationsInfoEXT set(int sType, long pNext, int sampleLocationsPerPixel, VkExtent2D sampleLocationGridSize, @Nullable VkSampleLocationEXT.Buffer pSampleLocations) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkSampleLocationsInfoEXTinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkSampleLocationsInfoEXTinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkSampleLocationsInfoEXTinstance allocated withBufferUtils. -
create
Returns a newVkSampleLocationsInfoEXTinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkSampleLocationsInfoEXT.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkSampleLocationsInfoEXT.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkSampleLocationsInfoEXT.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkSampleLocationsInfoEXT.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
mallocStack
@Deprecated public static VkSampleLocationsInfoEXT.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkSampleLocationsInfoEXT.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkSampleLocationsInfoEXTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkSampleLocationsInfoEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkSampleLocationsInfoEXT.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkSampleLocationsInfoEXT.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkSampleLocationsInfoEXT.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkSampleLocationsInfoEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
nsampleLocationsPerPixel
public static int nsampleLocationsPerPixel(long struct) Unsafe version ofsampleLocationsPerPixel(). -
nsampleLocationGridSize
Unsafe version ofsampleLocationGridSize(). -
nsampleLocationsCount
public static int nsampleLocationsCount(long struct) Unsafe version ofsampleLocationsCount(). -
npSampleLocations
Unsafe version ofpSampleLocations(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nsampleLocationsPerPixel
public static void nsampleLocationsPerPixel(long struct, int value) Unsafe version ofsampleLocationsPerPixel. -
nsampleLocationGridSize
Unsafe version ofsampleLocationGridSize. -
nsampleLocationsCount
public static void nsampleLocationsCount(long struct, int value) Sets the specified value to thesampleLocationsCountfield of the specifiedstruct. -
npSampleLocations
Unsafe version ofpSampleLocations. -
validate
public static void validate(long struct) Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-