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.NativeResourceStructure 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
attachmentIndexwas not created withIMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXTthen the values specified insampleLocationsInfoare ignored.Valid Usage
attachmentIndexmust be less than theattachmentCountspecified inVkRenderPassCreateInfothe render pass specified byVkRenderPassBeginInfo::renderPasswas created with
Valid Usage (Implicit)
sampleLocationsInfomust be a validVkSampleLocationsInfoEXTstructure
See Also
VkRenderPassSampleLocationsBeginInfoEXT,VkSampleLocationsInfoEXTLayout
struct VkAttachmentSampleLocationsEXT { uint32_tattachmentIndex();VkSampleLocationsInfoEXTsampleLocationsInfo(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkAttachmentSampleLocationsEXT.BufferAn array ofVkAttachmentSampleLocationsEXTstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intATTACHMENTINDEX
SAMPLELOCATIONSINFOThe struct member offsets.static intSIZEOFThe struct size in bytes.
-
Constructor Summary
Constructors Constructor Description VkAttachmentSampleLocationsEXT(java.nio.ByteBuffer container)Creates aVkAttachmentSampleLocationsEXTinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description intattachmentIndex()the index of the attachment for which the sample locations state is provided.VkAttachmentSampleLocationsEXTattachmentIndex(int value)Sets the specified value to theattachmentIndex()field.static VkAttachmentSampleLocationsEXTcalloc()Returns a newVkAttachmentSampleLocationsEXTinstance allocated withmemCalloc.static VkAttachmentSampleLocationsEXT.Buffercalloc(int capacity)Returns a newVkAttachmentSampleLocationsEXT.Bufferinstance allocated withmemCalloc.static VkAttachmentSampleLocationsEXT.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkAttachmentSampleLocationsEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkAttachmentSampleLocationsEXTcalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkAttachmentSampleLocationsEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkAttachmentSampleLocationsEXTcallocStack()Deprecated.static VkAttachmentSampleLocationsEXT.BuffercallocStack(int capacity)Deprecated.static VkAttachmentSampleLocationsEXT.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkAttachmentSampleLocationsEXTcallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static VkAttachmentSampleLocationsEXTcreate()Returns a newVkAttachmentSampleLocationsEXTinstance allocated withBufferUtils.static VkAttachmentSampleLocationsEXT.Buffercreate(int capacity)Returns a newVkAttachmentSampleLocationsEXT.Bufferinstance allocated withBufferUtils.static VkAttachmentSampleLocationsEXTcreate(long address)Returns a newVkAttachmentSampleLocationsEXTinstance for the specified memory address.static VkAttachmentSampleLocationsEXT.Buffercreate(long address, int capacity)Create aVkAttachmentSampleLocationsEXT.Bufferinstance at the specified memory.static VkAttachmentSampleLocationsEXTcreateSafe(long address)static VkAttachmentSampleLocationsEXT.BuffercreateSafe(long address, int capacity)static VkAttachmentSampleLocationsEXTmalloc()Returns a newVkAttachmentSampleLocationsEXTinstance allocated withmemAlloc.static VkAttachmentSampleLocationsEXT.Buffermalloc(int capacity)Returns a newVkAttachmentSampleLocationsEXT.Bufferinstance allocated withmemAlloc.static VkAttachmentSampleLocationsEXT.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkAttachmentSampleLocationsEXT.Bufferinstance allocated on the specifiedMemoryStack.static VkAttachmentSampleLocationsEXTmalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkAttachmentSampleLocationsEXTinstance allocated on the specifiedMemoryStack.static VkAttachmentSampleLocationsEXTmallocStack()Deprecated.static VkAttachmentSampleLocationsEXT.BuffermallocStack(int capacity)Deprecated.static VkAttachmentSampleLocationsEXT.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkAttachmentSampleLocationsEXTmallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static intnattachmentIndex(long struct)Unsafe version ofattachmentIndex().static voidnattachmentIndex(long struct, int value)Unsafe version ofattachmentIndex.static VkSampleLocationsInfoEXTnsampleLocationsInfo(long struct)Unsafe version ofsampleLocationsInfo().static voidnsampleLocationsInfo(long struct, VkSampleLocationsInfoEXT value)Unsafe version ofsampleLocationsInfo.VkSampleLocationsInfoEXTsampleLocationsInfo()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.VkAttachmentSampleLocationsEXTsampleLocationsInfo(java.util.function.Consumer<VkSampleLocationsInfoEXT> consumer)Passes thesampleLocationsInfo()field to the specifiedConsumer.VkAttachmentSampleLocationsEXTsampleLocationsInfo(VkSampleLocationsInfoEXT value)Copies the specifiedVkSampleLocationsInfoEXTto thesampleLocationsInfo()field.VkAttachmentSampleLocationsEXTset(int attachmentIndex, VkSampleLocationsInfoEXT sampleLocationsInfo)Initializes this struct with the specified values.VkAttachmentSampleLocationsEXTset(VkAttachmentSampleLocationsEXT src)Copies the specified struct data to this struct.intsizeof()static voidvalidate(long struct)Validates pointer members that should not beNULL.
-
-
-
Constructor Detail
-
VkAttachmentSampleLocationsEXT
public VkAttachmentSampleLocationsEXT(java.nio.ByteBuffer container)
Creates aVkAttachmentSampleLocationsEXTinstance 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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
attachmentIndex
public int attachmentIndex()
the index of the attachment for which the sample locations state is provided.
-
sampleLocationsInfo
public VkSampleLocationsInfoEXT 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.
-
attachmentIndex
public VkAttachmentSampleLocationsEXT attachmentIndex(int value)
Sets the specified value to theattachmentIndex()field.
-
sampleLocationsInfo
public VkAttachmentSampleLocationsEXT sampleLocationsInfo(VkSampleLocationsInfoEXT value)
Copies the specifiedVkSampleLocationsInfoEXTto 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 newVkAttachmentSampleLocationsEXTinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkAttachmentSampleLocationsEXT calloc()
Returns a newVkAttachmentSampleLocationsEXTinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkAttachmentSampleLocationsEXT create()
Returns a newVkAttachmentSampleLocationsEXTinstance allocated withBufferUtils.
-
create
public static VkAttachmentSampleLocationsEXT create(long address)
Returns a newVkAttachmentSampleLocationsEXTinstance for the specified memory address.
-
createSafe
@Nullable public static VkAttachmentSampleLocationsEXT createSafe(long address)
-
malloc
public static VkAttachmentSampleLocationsEXT.Buffer malloc(int capacity)
Returns a newVkAttachmentSampleLocationsEXT.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkAttachmentSampleLocationsEXT.Buffer calloc(int capacity)
Returns a newVkAttachmentSampleLocationsEXT.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkAttachmentSampleLocationsEXT.Buffer create(int capacity)
Returns a newVkAttachmentSampleLocationsEXT.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkAttachmentSampleLocationsEXT.Buffer create(long address, int capacity)
Create aVkAttachmentSampleLocationsEXT.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkAttachmentSampleLocationsEXT.Buffer createSafe(long address, int capacity)
-
mallocStack
@Deprecated public static VkAttachmentSampleLocationsEXT mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkAttachmentSampleLocationsEXT callocStack()
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkAttachmentSampleLocationsEXT mallocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkAttachmentSampleLocationsEXT callocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkAttachmentSampleLocationsEXT.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkAttachmentSampleLocationsEXT.Buffer callocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
mallocStack
@Deprecated public static VkAttachmentSampleLocationsEXT.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 VkAttachmentSampleLocationsEXT.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
malloc
public static VkAttachmentSampleLocationsEXT malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentSampleLocationsEXTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkAttachmentSampleLocationsEXT calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentSampleLocationsEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkAttachmentSampleLocationsEXT.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentSampleLocationsEXT.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkAttachmentSampleLocationsEXT.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentSampleLocationsEXT.Bufferinstance allocated on the specifiedMemoryStackand 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
-
-