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.NativeResourceStructure 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
subpassIndexwas not created withIMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXTor if the subpass does not use a depth/stencil attachment, andVkPhysicalDeviceSampleLocationsPropertiesEXT::variableSampleLocationsisTRUEthen the values specified insampleLocationsInfoare ignored.Valid Usage
subpassIndexmust be less than thesubpassCountspecified inVkRenderPassCreateInfothe render pass specified byVkRenderPassBeginInfo::renderPasswas created with
Valid Usage (Implicit)
sampleLocationsInfomust be a validVkSampleLocationsInfoEXTstructure
See Also
VkRenderPassSampleLocationsBeginInfoEXT,VkSampleLocationsInfoEXTMember 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;VkSampleLocationsInfoEXTsampleLocationsInfo; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkSubpassSampleLocationsEXT.BufferAn array ofVkSubpassSampleLocationsEXTstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intSAMPLELOCATIONSINFOThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSUBPASSINDEXThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkSubpassSampleLocationsEXT(java.nio.ByteBuffer container)Creates aVkSubpassSampleLocationsEXTinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkSubpassSampleLocationsEXTcalloc()Returns a newVkSubpassSampleLocationsEXTinstance allocated withmemCalloc.static VkSubpassSampleLocationsEXT.Buffercalloc(int capacity)Returns a newVkSubpassSampleLocationsEXT.Bufferinstance allocated withmemCalloc.static VkSubpassSampleLocationsEXTcallocStack()Returns a newVkSubpassSampleLocationsEXTinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkSubpassSampleLocationsEXT.BuffercallocStack(int capacity)Returns a newVkSubpassSampleLocationsEXT.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkSubpassSampleLocationsEXT.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkSubpassSampleLocationsEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkSubpassSampleLocationsEXTcallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkSubpassSampleLocationsEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkSubpassSampleLocationsEXTcreate()Returns a newVkSubpassSampleLocationsEXTinstance allocated withBufferUtils.static VkSubpassSampleLocationsEXT.Buffercreate(int capacity)Returns a newVkSubpassSampleLocationsEXT.Bufferinstance allocated withBufferUtils.static VkSubpassSampleLocationsEXTcreate(long address)Returns a newVkSubpassSampleLocationsEXTinstance for the specified memory address.static VkSubpassSampleLocationsEXT.Buffercreate(long address, int capacity)Create aVkSubpassSampleLocationsEXT.Bufferinstance at the specified memory.static VkSubpassSampleLocationsEXTcreateSafe(long address)static VkSubpassSampleLocationsEXT.BuffercreateSafe(long address, int capacity)static VkSubpassSampleLocationsEXTmalloc()Returns a newVkSubpassSampleLocationsEXTinstance allocated withmemAlloc.static VkSubpassSampleLocationsEXT.Buffermalloc(int capacity)Returns a newVkSubpassSampleLocationsEXT.Bufferinstance allocated withmemAlloc.static VkSubpassSampleLocationsEXTmallocStack()Returns a newVkSubpassSampleLocationsEXTinstance allocated on the thread-localMemoryStack.static VkSubpassSampleLocationsEXT.BuffermallocStack(int capacity)Returns a newVkSubpassSampleLocationsEXT.Bufferinstance allocated on the thread-localMemoryStack.static VkSubpassSampleLocationsEXT.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkSubpassSampleLocationsEXT.Bufferinstance allocated on the specifiedMemoryStack.static VkSubpassSampleLocationsEXTmallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkSubpassSampleLocationsEXTinstance allocated on the specifiedMemoryStack.static VkSampleLocationsInfoEXTnsampleLocationsInfo(long struct)Unsafe version ofsampleLocationsInfo().static voidnsampleLocationsInfo(long struct, VkSampleLocationsInfoEXT value)Unsafe version ofsampleLocationsInfo.static intnsubpassIndex(long struct)Unsafe version ofsubpassIndex().static voidnsubpassIndex(long struct, int value)Unsafe version ofsubpassIndex.VkSampleLocationsInfoEXTsampleLocationsInfo()Returns aVkSampleLocationsInfoEXTview of thesampleLocationsInfofield.VkSubpassSampleLocationsEXTsampleLocationsInfo(java.util.function.Consumer<VkSampleLocationsInfoEXT> consumer)Passes thesampleLocationsInfofield to the specifiedConsumer.VkSubpassSampleLocationsEXTsampleLocationsInfo(VkSampleLocationsInfoEXT value)Copies the specifiedVkSampleLocationsInfoEXTto thesampleLocationsInfofield.VkSubpassSampleLocationsEXTset(int subpassIndex, VkSampleLocationsInfoEXT sampleLocationsInfo)Initializes this struct with the specified values.VkSubpassSampleLocationsEXTset(VkSubpassSampleLocationsEXT src)Copies the specified struct data to this struct.intsizeof()intsubpassIndex()Returns the value of thesubpassIndexfield.VkSubpassSampleLocationsEXTsubpassIndex(int value)Sets the specified value to thesubpassIndexfield.static voidvalidate(long struct)Validates pointer members that should not beNULL.static voidvalidate(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 aVkSubpassSampleLocationsEXTinstance 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
-
subpassIndex
public int subpassIndex()
Returns the value of thesubpassIndexfield.
-
sampleLocationsInfo
public VkSampleLocationsInfoEXT sampleLocationsInfo()
Returns aVkSampleLocationsInfoEXTview of thesampleLocationsInfofield.
-
subpassIndex
public VkSubpassSampleLocationsEXT subpassIndex(int value)
Sets the specified value to thesubpassIndexfield.
-
sampleLocationsInfo
public VkSubpassSampleLocationsEXT sampleLocationsInfo(VkSampleLocationsInfoEXT value)
Copies the specifiedVkSampleLocationsInfoEXTto thesampleLocationsInfofield.
-
sampleLocationsInfo
public VkSubpassSampleLocationsEXT sampleLocationsInfo(java.util.function.Consumer<VkSampleLocationsInfoEXT> consumer)
Passes thesampleLocationsInfofield 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 newVkSubpassSampleLocationsEXTinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkSubpassSampleLocationsEXT calloc()
Returns a newVkSubpassSampleLocationsEXTinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkSubpassSampleLocationsEXT create()
Returns a newVkSubpassSampleLocationsEXTinstance allocated withBufferUtils.
-
create
public static VkSubpassSampleLocationsEXT create(long address)
Returns a newVkSubpassSampleLocationsEXTinstance for the specified memory address.
-
createSafe
@Nullable public static VkSubpassSampleLocationsEXT createSafe(long address)
-
malloc
public static VkSubpassSampleLocationsEXT.Buffer malloc(int capacity)
Returns a newVkSubpassSampleLocationsEXT.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkSubpassSampleLocationsEXT.Buffer calloc(int capacity)
Returns a newVkSubpassSampleLocationsEXT.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkSubpassSampleLocationsEXT.Buffer create(int capacity)
Returns a newVkSubpassSampleLocationsEXT.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkSubpassSampleLocationsEXT.Buffer create(long address, int capacity)
Create aVkSubpassSampleLocationsEXT.Bufferinstance 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 newVkSubpassSampleLocationsEXTinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkSubpassSampleLocationsEXT callocStack()
Returns a newVkSubpassSampleLocationsEXTinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkSubpassSampleLocationsEXT mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSubpassSampleLocationsEXTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkSubpassSampleLocationsEXT callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSubpassSampleLocationsEXTinstance allocated on the specifiedMemoryStackand 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.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkSubpassSampleLocationsEXT.Buffer callocStack(int capacity)
Returns a newVkSubpassSampleLocationsEXT.Bufferinstance allocated on the thread-localMemoryStackand 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.Bufferinstance 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.Bufferinstance allocated on the specifiedMemoryStackand 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
-
-