Package org.lwjgl.vulkan
Class VkAttachmentSampleLocationsEXT
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkAttachmentSampleLocationsEXT
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkAttachmentSampleLocationsEXT extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Structure specifying the sample locations state to use in the initial layout transition of attachments.Description
If the image referenced by the framebuffer attachment at index
attachmentIndex
was not created withIMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT
then the values specified insampleLocationsInfo
are ignored.Valid Usage
attachmentIndex
must be less than theattachmentCount
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
attachmentIndex
– the index of the attachment for which the sample locations state is provided.sampleLocationsInfo
– the sample locations state to use for the layout transition of the given attachment from the initial layout of the attachment to the image layout specified for the attachment in the first subpass using it.
Layout
struct VkAttachmentSampleLocationsEXT { uint32_t attachmentIndex;
VkSampleLocationsInfoEXT
sampleLocationsInfo; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkAttachmentSampleLocationsEXT.Buffer
An array ofVkAttachmentSampleLocationsEXT
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
ATTACHMENTINDEX
SAMPLELOCATIONSINFOThe struct member offsets.static int
SIZEOF
The struct size in bytes.
-
Constructor Summary
Constructors Constructor Description VkAttachmentSampleLocationsEXT(java.nio.ByteBuffer container)
Creates aVkAttachmentSampleLocationsEXT
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
attachmentIndex()
Returns the value of theattachmentIndex
field.VkAttachmentSampleLocationsEXT
attachmentIndex(int value)
Sets the specified value to theattachmentIndex
field.static VkAttachmentSampleLocationsEXT
calloc()
Returns a newVkAttachmentSampleLocationsEXT
instance allocated withmemCalloc
.static VkAttachmentSampleLocationsEXT.Buffer
calloc(int capacity)
Returns a newVkAttachmentSampleLocationsEXT.Buffer
instance allocated withmemCalloc
.static VkAttachmentSampleLocationsEXT
callocStack()
Returns a newVkAttachmentSampleLocationsEXT
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkAttachmentSampleLocationsEXT.Buffer
callocStack(int capacity)
Returns a newVkAttachmentSampleLocationsEXT.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkAttachmentSampleLocationsEXT.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentSampleLocationsEXT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkAttachmentSampleLocationsEXT
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentSampleLocationsEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkAttachmentSampleLocationsEXT
create()
Returns a newVkAttachmentSampleLocationsEXT
instance allocated withBufferUtils
.static VkAttachmentSampleLocationsEXT.Buffer
create(int capacity)
Returns a newVkAttachmentSampleLocationsEXT.Buffer
instance allocated withBufferUtils
.static VkAttachmentSampleLocationsEXT
create(long address)
Returns a newVkAttachmentSampleLocationsEXT
instance for the specified memory address.static VkAttachmentSampleLocationsEXT.Buffer
create(long address, int capacity)
Create aVkAttachmentSampleLocationsEXT.Buffer
instance at the specified memory.static VkAttachmentSampleLocationsEXT
createSafe(long address)
static VkAttachmentSampleLocationsEXT.Buffer
createSafe(long address, int capacity)
static VkAttachmentSampleLocationsEXT
malloc()
Returns a newVkAttachmentSampleLocationsEXT
instance allocated withmemAlloc
.static VkAttachmentSampleLocationsEXT.Buffer
malloc(int capacity)
Returns a newVkAttachmentSampleLocationsEXT.Buffer
instance allocated withmemAlloc
.static VkAttachmentSampleLocationsEXT
mallocStack()
Returns a newVkAttachmentSampleLocationsEXT
instance allocated on the thread-localMemoryStack
.static VkAttachmentSampleLocationsEXT.Buffer
mallocStack(int capacity)
Returns a newVkAttachmentSampleLocationsEXT.Buffer
instance allocated on the thread-localMemoryStack
.static VkAttachmentSampleLocationsEXT.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentSampleLocationsEXT.Buffer
instance allocated on the specifiedMemoryStack
.static VkAttachmentSampleLocationsEXT
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentSampleLocationsEXT
instance allocated on the specifiedMemoryStack
.static int
nattachmentIndex(long struct)
Unsafe version ofattachmentIndex()
.static void
nattachmentIndex(long struct, int value)
Unsafe version ofattachmentIndex
.static VkSampleLocationsInfoEXT
nsampleLocationsInfo(long struct)
Unsafe version ofsampleLocationsInfo()
.static void
nsampleLocationsInfo(long struct, VkSampleLocationsInfoEXT value)
Unsafe version ofsampleLocationsInfo
.VkSampleLocationsInfoEXT
sampleLocationsInfo()
Returns aVkSampleLocationsInfoEXT
view of thesampleLocationsInfo
field.VkAttachmentSampleLocationsEXT
sampleLocationsInfo(java.util.function.Consumer<VkSampleLocationsInfoEXT> consumer)
Passes thesampleLocationsInfo
field to the specifiedConsumer
.VkAttachmentSampleLocationsEXT
sampleLocationsInfo(VkSampleLocationsInfoEXT value)
Copies the specifiedVkSampleLocationsInfoEXT
to thesampleLocationsInfo
field.VkAttachmentSampleLocationsEXT
set(int attachmentIndex, VkSampleLocationsInfoEXT sampleLocationsInfo)
Initializes this struct with the specified values.VkAttachmentSampleLocationsEXT
set(VkAttachmentSampleLocationsEXT src)
Copies the specified struct data to this struct.int
sizeof()
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
-
VkAttachmentSampleLocationsEXT
public VkAttachmentSampleLocationsEXT(java.nio.ByteBuffer container)
Creates aVkAttachmentSampleLocationsEXT
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
-
attachmentIndex
public int attachmentIndex()
Returns the value of theattachmentIndex
field.
-
sampleLocationsInfo
public VkSampleLocationsInfoEXT sampleLocationsInfo()
Returns aVkSampleLocationsInfoEXT
view of thesampleLocationsInfo
field.
-
attachmentIndex
public VkAttachmentSampleLocationsEXT attachmentIndex(int value)
Sets the specified value to theattachmentIndex
field.
-
sampleLocationsInfo
public VkAttachmentSampleLocationsEXT sampleLocationsInfo(VkSampleLocationsInfoEXT value)
Copies the specifiedVkSampleLocationsInfoEXT
to thesampleLocationsInfo
field.
-
sampleLocationsInfo
public VkAttachmentSampleLocationsEXT sampleLocationsInfo(java.util.function.Consumer<VkSampleLocationsInfoEXT> consumer)
Passes thesampleLocationsInfo
field to the specifiedConsumer
.
-
set
public VkAttachmentSampleLocationsEXT set(int attachmentIndex, VkSampleLocationsInfoEXT sampleLocationsInfo)
Initializes this struct with the specified values.
-
set
public VkAttachmentSampleLocationsEXT set(VkAttachmentSampleLocationsEXT src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkAttachmentSampleLocationsEXT malloc()
Returns a newVkAttachmentSampleLocationsEXT
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkAttachmentSampleLocationsEXT calloc()
Returns a newVkAttachmentSampleLocationsEXT
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkAttachmentSampleLocationsEXT create()
Returns a newVkAttachmentSampleLocationsEXT
instance allocated withBufferUtils
.
-
create
public static VkAttachmentSampleLocationsEXT create(long address)
Returns a newVkAttachmentSampleLocationsEXT
instance for the specified memory address.
-
createSafe
@Nullable public static VkAttachmentSampleLocationsEXT createSafe(long address)
-
malloc
public static VkAttachmentSampleLocationsEXT.Buffer malloc(int capacity)
Returns a newVkAttachmentSampleLocationsEXT.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkAttachmentSampleLocationsEXT.Buffer calloc(int capacity)
Returns a newVkAttachmentSampleLocationsEXT.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkAttachmentSampleLocationsEXT.Buffer create(int capacity)
Returns a newVkAttachmentSampleLocationsEXT.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkAttachmentSampleLocationsEXT.Buffer create(long address, int capacity)
Create aVkAttachmentSampleLocationsEXT.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkAttachmentSampleLocationsEXT.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkAttachmentSampleLocationsEXT mallocStack()
Returns a newVkAttachmentSampleLocationsEXT
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkAttachmentSampleLocationsEXT callocStack()
Returns a newVkAttachmentSampleLocationsEXT
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkAttachmentSampleLocationsEXT mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentSampleLocationsEXT
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkAttachmentSampleLocationsEXT callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentSampleLocationsEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkAttachmentSampleLocationsEXT.Buffer mallocStack(int capacity)
Returns a newVkAttachmentSampleLocationsEXT.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkAttachmentSampleLocationsEXT.Buffer callocStack(int capacity)
Returns a newVkAttachmentSampleLocationsEXT.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkAttachmentSampleLocationsEXT.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentSampleLocationsEXT.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkAttachmentSampleLocationsEXT.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentSampleLocationsEXT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nattachmentIndex
public static int nattachmentIndex(long struct)
Unsafe version ofattachmentIndex()
.
-
nsampleLocationsInfo
public static VkSampleLocationsInfoEXT nsampleLocationsInfo(long struct)
Unsafe version ofsampleLocationsInfo()
.
-
nattachmentIndex
public static void nattachmentIndex(long struct, int value)
Unsafe version ofattachmentIndex
.
-
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
-
-