Package org.lwjgl.vulkan
Class VkSubpassSampleLocationsEXT
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkSubpassSampleLocationsEXT
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkSubpassSampleLocationsEXT extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Structure specifying the sample locations state to use for layout transitions of attachments performed after a given subpass.Description
If the image referenced by the depth/stencil attachment used in the subpass identified by
subpassIndex
was not created withIMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT
or if the subpass does not use a depth/stencil attachment, andVkPhysicalDeviceSampleLocationsPropertiesEXT
::variableSampleLocations
isTRUE
then the values specified insampleLocationsInfo
are ignored.Valid Usage
subpassIndex
must be less than thesubpassCount
specified inVkRenderPassCreateInfo
the render pass specified byVkRenderPassBeginInfo
::renderPass
was created with
Valid Usage (Implicit)
sampleLocationsInfo
must be a validVkSampleLocationsInfoEXT
structure
See Also
VkRenderPassSampleLocationsBeginInfoEXT
,VkSampleLocationsInfoEXT
Member documentation
subpassIndex
– the index of the subpass for which the sample locations state is provided.sampleLocationsInfo
– the sample locations state to use for the layout transition of the depth/stencil attachment away from the image layout the attachment is used with in the subpass specified insubpassIndex
.
Layout
struct VkSubpassSampleLocationsEXT { uint32_t subpassIndex;
VkSampleLocationsInfoEXT
sampleLocationsInfo; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkSubpassSampleLocationsEXT.Buffer
An array ofVkSubpassSampleLocationsEXT
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
SAMPLELOCATIONSINFO
The struct member offsets.static int
SIZEOF
The struct size in bytes.static int
SUBPASSINDEX
The struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkSubpassSampleLocationsEXT(java.nio.ByteBuffer container)
Creates aVkSubpassSampleLocationsEXT
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkSubpassSampleLocationsEXT
calloc()
Returns a newVkSubpassSampleLocationsEXT
instance allocated withmemCalloc
.static VkSubpassSampleLocationsEXT.Buffer
calloc(int capacity)
Returns a newVkSubpassSampleLocationsEXT.Buffer
instance allocated withmemCalloc
.static VkSubpassSampleLocationsEXT
callocStack()
Returns a newVkSubpassSampleLocationsEXT
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkSubpassSampleLocationsEXT.Buffer
callocStack(int capacity)
Returns a newVkSubpassSampleLocationsEXT.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkSubpassSampleLocationsEXT.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSubpassSampleLocationsEXT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSubpassSampleLocationsEXT
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSubpassSampleLocationsEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSubpassSampleLocationsEXT
create()
Returns a newVkSubpassSampleLocationsEXT
instance allocated withBufferUtils
.static VkSubpassSampleLocationsEXT.Buffer
create(int capacity)
Returns a newVkSubpassSampleLocationsEXT.Buffer
instance allocated withBufferUtils
.static VkSubpassSampleLocationsEXT
create(long address)
Returns a newVkSubpassSampleLocationsEXT
instance for the specified memory address.static VkSubpassSampleLocationsEXT.Buffer
create(long address, int capacity)
Create aVkSubpassSampleLocationsEXT.Buffer
instance at the specified memory.static VkSubpassSampleLocationsEXT
createSafe(long address)
static VkSubpassSampleLocationsEXT.Buffer
createSafe(long address, int capacity)
static VkSubpassSampleLocationsEXT
malloc()
Returns a newVkSubpassSampleLocationsEXT
instance allocated withmemAlloc
.static VkSubpassSampleLocationsEXT.Buffer
malloc(int capacity)
Returns a newVkSubpassSampleLocationsEXT.Buffer
instance allocated withmemAlloc
.static VkSubpassSampleLocationsEXT
mallocStack()
Returns a newVkSubpassSampleLocationsEXT
instance allocated on the thread-localMemoryStack
.static VkSubpassSampleLocationsEXT.Buffer
mallocStack(int capacity)
Returns a newVkSubpassSampleLocationsEXT.Buffer
instance allocated on the thread-localMemoryStack
.static VkSubpassSampleLocationsEXT.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSubpassSampleLocationsEXT.Buffer
instance allocated on the specifiedMemoryStack
.static VkSubpassSampleLocationsEXT
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSubpassSampleLocationsEXT
instance allocated on the specifiedMemoryStack
.static VkSampleLocationsInfoEXT
nsampleLocationsInfo(long struct)
Unsafe version ofsampleLocationsInfo()
.static void
nsampleLocationsInfo(long struct, VkSampleLocationsInfoEXT value)
Unsafe version ofsampleLocationsInfo
.static int
nsubpassIndex(long struct)
Unsafe version ofsubpassIndex()
.static void
nsubpassIndex(long struct, int value)
Unsafe version ofsubpassIndex
.VkSampleLocationsInfoEXT
sampleLocationsInfo()
Returns aVkSampleLocationsInfoEXT
view of thesampleLocationsInfo
field.VkSubpassSampleLocationsEXT
sampleLocationsInfo(java.util.function.Consumer<VkSampleLocationsInfoEXT> consumer)
Passes thesampleLocationsInfo
field to the specifiedConsumer
.VkSubpassSampleLocationsEXT
sampleLocationsInfo(VkSampleLocationsInfoEXT value)
Copies the specifiedVkSampleLocationsInfoEXT
to thesampleLocationsInfo
field.VkSubpassSampleLocationsEXT
set(int subpassIndex, VkSampleLocationsInfoEXT sampleLocationsInfo)
Initializes this struct with the specified values.VkSubpassSampleLocationsEXT
set(VkSubpassSampleLocationsEXT src)
Copies the specified struct data to this struct.int
sizeof()
int
subpassIndex()
Returns the value of thesubpassIndex
field.VkSubpassSampleLocationsEXT
subpassIndex(int value)
Sets the specified value to thesubpassIndex
field.static void
validate(long struct)
Validates pointer members that should not beNULL
.static void
validate(long array, int count)
Callsvalidate(long)
for each struct contained in the specified struct array.
-
-
-
Constructor Detail
-
VkSubpassSampleLocationsEXT
public VkSubpassSampleLocationsEXT(java.nio.ByteBuffer container)
Creates aVkSubpassSampleLocationsEXT
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
subpassIndex
public int subpassIndex()
Returns the value of thesubpassIndex
field.
-
sampleLocationsInfo
public VkSampleLocationsInfoEXT sampleLocationsInfo()
Returns aVkSampleLocationsInfoEXT
view of thesampleLocationsInfo
field.
-
subpassIndex
public VkSubpassSampleLocationsEXT subpassIndex(int value)
Sets the specified value to thesubpassIndex
field.
-
sampleLocationsInfo
public VkSubpassSampleLocationsEXT sampleLocationsInfo(VkSampleLocationsInfoEXT value)
Copies the specifiedVkSampleLocationsInfoEXT
to thesampleLocationsInfo
field.
-
sampleLocationsInfo
public VkSubpassSampleLocationsEXT sampleLocationsInfo(java.util.function.Consumer<VkSampleLocationsInfoEXT> consumer)
Passes thesampleLocationsInfo
field to the specifiedConsumer
.
-
set
public VkSubpassSampleLocationsEXT set(int subpassIndex, VkSampleLocationsInfoEXT sampleLocationsInfo)
Initializes this struct with the specified values.
-
set
public VkSubpassSampleLocationsEXT set(VkSubpassSampleLocationsEXT src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkSubpassSampleLocationsEXT malloc()
Returns a newVkSubpassSampleLocationsEXT
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkSubpassSampleLocationsEXT calloc()
Returns a newVkSubpassSampleLocationsEXT
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkSubpassSampleLocationsEXT create()
Returns a newVkSubpassSampleLocationsEXT
instance allocated withBufferUtils
.
-
create
public static VkSubpassSampleLocationsEXT create(long address)
Returns a newVkSubpassSampleLocationsEXT
instance for the specified memory address.
-
createSafe
@Nullable public static VkSubpassSampleLocationsEXT createSafe(long address)
-
malloc
public static VkSubpassSampleLocationsEXT.Buffer malloc(int capacity)
Returns a newVkSubpassSampleLocationsEXT.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkSubpassSampleLocationsEXT.Buffer calloc(int capacity)
Returns a newVkSubpassSampleLocationsEXT.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkSubpassSampleLocationsEXT.Buffer create(int capacity)
Returns a newVkSubpassSampleLocationsEXT.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkSubpassSampleLocationsEXT.Buffer create(long address, int capacity)
Create aVkSubpassSampleLocationsEXT.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkSubpassSampleLocationsEXT.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkSubpassSampleLocationsEXT mallocStack()
Returns a newVkSubpassSampleLocationsEXT
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkSubpassSampleLocationsEXT callocStack()
Returns a newVkSubpassSampleLocationsEXT
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkSubpassSampleLocationsEXT mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSubpassSampleLocationsEXT
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkSubpassSampleLocationsEXT callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSubpassSampleLocationsEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkSubpassSampleLocationsEXT.Buffer mallocStack(int capacity)
Returns a newVkSubpassSampleLocationsEXT.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkSubpassSampleLocationsEXT.Buffer callocStack(int capacity)
Returns a newVkSubpassSampleLocationsEXT.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkSubpassSampleLocationsEXT.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSubpassSampleLocationsEXT.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkSubpassSampleLocationsEXT.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSubpassSampleLocationsEXT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nsubpassIndex
public static int nsubpassIndex(long struct)
Unsafe version ofsubpassIndex()
.
-
nsampleLocationsInfo
public static VkSampleLocationsInfoEXT nsampleLocationsInfo(long struct)
Unsafe version ofsampleLocationsInfo()
.
-
nsubpassIndex
public static void nsubpassIndex(long struct, int value)
Unsafe version ofsubpassIndex
.
-
nsampleLocationsInfo
public static void nsampleLocationsInfo(long struct, VkSampleLocationsInfoEXT value)
Unsafe version ofsampleLocationsInfo
.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL
.- Parameters:
struct
- the struct to validate
-
validate
public static void validate(long array, int count)
Callsvalidate(long)
for each struct contained in the specified struct array.- Parameters:
array
- the struct array to validatecount
- the number of structs inarray
-
-