Class VkSampleLocationsInfoEXT
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,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
sampleLocationsPerPixel
must be a bit value that is set inVkPhysicalDeviceSampleLocationsPropertiesEXT
::sampleLocationSampleCounts
sampleLocationsCount
must equalsampleLocationsPerPixel × sampleLocationGridSize.width × sampleLocationGridSize.height
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_SAMPLE_LOCATIONS_INFO_EXT
- If
sampleLocationsCount
is not 0,pSampleLocations
must be a valid pointer to an array ofsampleLocationsCount
VkSampleLocationEXT
structures
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 classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionVkSampleLocationsInfoEXT
(ByteBuffer container) Creates aVkSampleLocationsInfoEXT
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkSampleLocationsInfoEXT
calloc()
Returns a newVkSampleLocationsInfoEXT
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkSampleLocationsInfoEXT.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkSampleLocationsInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSampleLocationsInfoEXT
calloc
(MemoryStack stack) Returns a newVkSampleLocationsInfoEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSampleLocationsInfoEXT
Deprecated.callocStack
(int capacity) Deprecated.callocStack
(int capacity, MemoryStack stack) Deprecated.static VkSampleLocationsInfoEXT
callocStack
(MemoryStack stack) Deprecated.static VkSampleLocationsInfoEXT
create()
Returns a newVkSampleLocationsInfoEXT
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkSampleLocationsInfoEXT.Buffer
instance allocated withBufferUtils
.static VkSampleLocationsInfoEXT
create
(long address) Returns a newVkSampleLocationsInfoEXT
instance for the specified memory address.create
(long address, int capacity) Create aVkSampleLocationsInfoEXT.Buffer
instance at the specified memory.static VkSampleLocationsInfoEXT
createSafe
(long address) createSafe
(long address, int capacity) static VkSampleLocationsInfoEXT
malloc()
Returns a newVkSampleLocationsInfoEXT
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkSampleLocationsInfoEXT.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkSampleLocationsInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
.static VkSampleLocationsInfoEXT
malloc
(MemoryStack stack) Returns a newVkSampleLocationsInfoEXT
instance allocated on the specifiedMemoryStack
.static VkSampleLocationsInfoEXT
Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.static VkSampleLocationsInfoEXT
mallocStack
(MemoryStack stack) Deprecated.static long
npNext
(long struct) Unsafe version ofpNext()
.static void
npNext
(long struct, long value) Unsafe version ofpNext
.static VkSampleLocationEXT.Buffer
npSampleLocations
(long struct) Unsafe version ofpSampleLocations()
.static void
npSampleLocations
(long struct, VkSampleLocationEXT.Buffer value) Unsafe version ofpSampleLocations
.static VkExtent2D
nsampleLocationGridSize
(long struct) Unsafe version ofsampleLocationGridSize()
.static void
nsampleLocationGridSize
(long struct, VkExtent2D value) Unsafe version ofsampleLocationGridSize
.static int
nsampleLocationsCount
(long struct) Unsafe version ofsampleLocationsCount()
.static void
nsampleLocationsCount
(long struct, int value) Sets the specified value to thesampleLocationsCount
field of the specifiedstruct
.static int
nsampleLocationsPerPixel
(long struct) Unsafe version ofsampleLocationsPerPixel()
.static void
nsampleLocationsPerPixel
(long struct, int value) Unsafe version ofsampleLocationsPerPixel
.static int
nsType
(long struct) Unsafe version ofsType()
.static void
nsType
(long struct, int value) Unsafe version ofsType
.long
pNext()
NULL
or a pointer to a structure extending this structure.pNext
(long value) Sets the specified value to thepNext()
field.a pointer to an array ofsampleLocationsCount
VkSampleLocationEXT
structures.Sets the address of the specifiedVkSampleLocationEXT.Buffer
to 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 specifiedVkExtent2D
to thesampleLocationGridSize()
field.int
the number of sample locations inpSampleLocations
.int
aVkSampleCountFlagBits
value 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, VkSampleLocationEXT.Buffer pSampleLocations) Initializes this struct with the specified values.Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.int
sType()
aVkStructureType
value identifying this structure.sType
(int value) Sets the specified value to thesType()
field.Sets theSTRUCTURE_TYPE_SAMPLE_LOCATIONS_INFO_EXT
value to thesType()
field.static void
validate
(long struct) Validates pointer members that should not beNULL
.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods 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 aVkSampleLocationsInfoEXT
instance at the current position of the specifiedByteBuffer
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()Description copied from class:Struct
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkSampleLocationsInfoEXT>
-
sType
public int sType()aVkStructureType
value identifying this structure. -
pNext
public long pNext()NULL
or a pointer to a structure extending this structure. -
sampleLocationsPerPixel
public int sampleLocationsPerPixel()aVkSampleCountFlagBits
value 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 ofsampleLocationsCount
VkSampleLocationEXT
structures. -
sType
Sets the specified value to thesType()
field. -
sType$Default
Sets theSTRUCTURE_TYPE_SAMPLE_LOCATIONS_INFO_EXT
value to thesType()
field. -
pNext
Sets the specified value to thepNext()
field. -
sampleLocationsPerPixel
Sets the specified value to thesampleLocationsPerPixel()
field. -
sampleLocationGridSize
Copies the specifiedVkExtent2D
to thesampleLocationGridSize()
field. -
sampleLocationGridSize
Passes thesampleLocationGridSize()
field to the specifiedConsumer
. -
pSampleLocations
Sets the address of the specifiedVkSampleLocationEXT.Buffer
to 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 newVkSampleLocationsInfoEXT
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkSampleLocationsInfoEXT
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkSampleLocationsInfoEXT
instance allocated withBufferUtils
. -
create
Returns a newVkSampleLocationsInfoEXT
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkSampleLocationsInfoEXT.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkSampleLocationsInfoEXT.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkSampleLocationsInfoEXT.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkSampleLocationsInfoEXT.Buffer
instance 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, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkSampleLocationsInfoEXT.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkSampleLocationsInfoEXT
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkSampleLocationsInfoEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkSampleLocationsInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkSampleLocationsInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
and 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 thesampleLocationsCount
field 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
-