Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkSubpassSampleLocationsEXT

extends Struct<VkSubpassSampleLocationsEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
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 with IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT or if the subpass does not use a depth/stencil attachment, and VkPhysicalDeviceSampleLocationsPropertiesEXT::variableSampleLocations is TRUE then the values specified in sampleLocationsInfo are ignored.

Valid Usage
Valid Usage (Implicit)
See Also

VkRenderPassSampleLocationsBeginInfoEXT, VkSampleLocationsInfoEXT

Layout


struct VkSubpassSampleLocationsEXT {
    uint32_t subpassIndex;
    VkSampleLocationsInfoEXT sampleLocationsInfo;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkSubpassSampleLocationsEXT.Buffer

An array of VkSubpassSampleLocationsEXT structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
SAMPLELOCATIONSINFO

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SUBPASSINDEX

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkSubpassSampleLocationsEXT(long address, ByteBuffer container)

public
VkSubpassSampleLocationsEXT(ByteBuffer container)

Creates a VkSubpassSampleLocationsEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkSubpassSampleLocationsEXT
calloc()

Returns a new VkSubpassSampleLocationsEXT instance allocated with memCalloc.

public static VkSubpassSampleLocationsEXT.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new VkSubpassSampleLocationsEXT.Buffer instance allocated with memCalloc.

public static VkSubpassSampleLocationsEXT
calloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkSubpassSampleLocationsEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkSubpassSampleLocationsEXT.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new VkSubpassSampleLocationsEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkSubpassSampleLocationsEXT
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkSubpassSampleLocationsEXT
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSubpassSampleLocationsEXT.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSubpassSampleLocationsEXT.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkSubpassSampleLocationsEXT
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkSubpassSampleLocationsEXT
create()

Returns a new VkSubpassSampleLocationsEXT instance allocated with BufferUtils.

public static VkSubpassSampleLocationsEXT
create(long address)

Returns a new VkSubpassSampleLocationsEXT instance for the specified memory address.

public static VkSubpassSampleLocationsEXT.Buffer
create(int
the buffer capacity
capacity)

Returns a new VkSubpassSampleLocationsEXT.Buffer instance allocated with BufferUtils.

public static VkSubpassSampleLocationsEXT.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Create a VkSubpassSampleLocationsEXT.Buffer instance at the specified memory.

public static VkSubpassSampleLocationsEXT
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkSubpassSampleLocationsEXT.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static VkSubpassSampleLocationsEXT
malloc()

Returns a new VkSubpassSampleLocationsEXT instance allocated with memAlloc.

public static VkSubpassSampleLocationsEXT.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new VkSubpassSampleLocationsEXT.Buffer instance allocated with memAlloc.

public static VkSubpassSampleLocationsEXT
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkSubpassSampleLocationsEXT instance allocated on the specified MemoryStack.

public static VkSubpassSampleLocationsEXT.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new VkSubpassSampleLocationsEXT.Buffer instance allocated on the specified MemoryStack.

public static VkSubpassSampleLocationsEXT
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkSubpassSampleLocationsEXT
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSubpassSampleLocationsEXT.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSubpassSampleLocationsEXT.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSampleLocationsInfoEXT
nsampleLocationsInfo(long struct)

Unsafe version of sampleLocationsInfo.

public static void
nsampleLocationsInfo(long struct, VkSampleLocationsInfoEXT value)

Unsafe version of sampleLocationsInfo.

public static int
nsubpassIndex(long struct)

Unsafe version of subpassIndex.

public static void
nsubpassIndex(long struct, int value)

Unsafe version of subpassIndex.

public VkSampleLocationsInfoEXT
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 in subpassIndex.

public VkSubpassSampleLocationsEXT
sampleLocationsInfo(VkSampleLocationsInfoEXT value)

Copies the specified VkSampleLocationsInfoEXT to the sampleLocationsInfo field.

public VkSubpassSampleLocationsEXT
sampleLocationsInfo(Consumer<VkSampleLocationsInfoEXT> consumer)

Passes the sampleLocationsInfo field to the specified Consumer.

public VkSubpassSampleLocationsEXT
set(int subpassIndex, VkSampleLocationsInfoEXT sampleLocationsInfo)

Initializes this struct with the specified values.

public VkSubpassSampleLocationsEXT

Returns:

this struct
set(VkSubpassSampleLocationsEXT
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
subpassIndex()

the index of the subpass for which the sample locations state is provided.

public VkSubpassSampleLocationsEXT
subpassIndex(int value)

Sets the specified value to the subpassIndex field.

public static void
validate(long
the struct to validate
struct)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

SAMPLELOCATIONSINFOback to summary
public static final int SAMPLELOCATIONSINFO

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SUBPASSINDEXback to summary
public static final int SUBPASSINDEX

The struct member offsets.

Constructor Detail

VkSubpassSampleLocationsEXTback to summary
protected VkSubpassSampleLocationsEXT(long address, ByteBuffer container)
VkSubpassSampleLocationsEXTback to summary
public VkSubpassSampleLocationsEXT(ByteBuffer container)

Creates a VkSubpassSampleLocationsEXT instance at the current position of the specified ByteBuffer 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

callocback to summary
public static VkSubpassSampleLocationsEXT calloc()

Returns a new VkSubpassSampleLocationsEXT instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VkSubpassSampleLocationsEXT.Buffer calloc(int capacity)

Returns a new VkSubpassSampleLocationsEXT.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkSubpassSampleLocationsEXT calloc(MemoryStack stack)

Returns a new VkSubpassSampleLocationsEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkSubpassSampleLocationsEXT.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkSubpassSampleLocationsEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkSubpassSampleLocationsEXT callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkSubpassSampleLocationsEXT callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkSubpassSampleLocationsEXT.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkSubpassSampleLocationsEXT.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected VkSubpassSampleLocationsEXT create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkSubpassSampleLocationsEXT create()

Returns a new VkSubpassSampleLocationsEXT instance allocated with BufferUtils.

createback to summary
public static VkSubpassSampleLocationsEXT create(long address)

Returns a new VkSubpassSampleLocationsEXT instance for the specified memory address.

createback to summary
public static VkSubpassSampleLocationsEXT.Buffer create(int capacity)

Returns a new VkSubpassSampleLocationsEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkSubpassSampleLocationsEXT.Buffer create(long address, int capacity)

Create a VkSubpassSampleLocationsEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkSubpassSampleLocationsEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkSubpassSampleLocationsEXT.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkSubpassSampleLocationsEXT malloc()

Returns a new VkSubpassSampleLocationsEXT instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VkSubpassSampleLocationsEXT.Buffer malloc(int capacity)

Returns a new VkSubpassSampleLocationsEXT.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkSubpassSampleLocationsEXT malloc(MemoryStack stack)

Returns a new VkSubpassSampleLocationsEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkSubpassSampleLocationsEXT.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkSubpassSampleLocationsEXT.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkSubpassSampleLocationsEXT mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkSubpassSampleLocationsEXT mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkSubpassSampleLocationsEXT.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkSubpassSampleLocationsEXT.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
nsampleLocationsInfoback to summary
public static VkSampleLocationsInfoEXT nsampleLocationsInfo(long struct)

Unsafe version of sampleLocationsInfo.

nsampleLocationsInfoback to summary
public static void nsampleLocationsInfo(long struct, VkSampleLocationsInfoEXT value)

Unsafe version of sampleLocationsInfo.

nsubpassIndexback to summary
public static int nsubpassIndex(long struct)

Unsafe version of subpassIndex.

nsubpassIndexback to summary
public static void nsubpassIndex(long struct, int value)

Unsafe version of subpassIndex.

sampleLocationsInfoback to summary
public VkSampleLocationsInfoEXT 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 in subpassIndex.

sampleLocationsInfoback to summary
public VkSubpassSampleLocationsEXT sampleLocationsInfo(VkSampleLocationsInfoEXT value)

Copies the specified VkSampleLocationsInfoEXT to the sampleLocationsInfo field.

sampleLocationsInfoback to summary
public VkSubpassSampleLocationsEXT sampleLocationsInfo(Consumer<VkSampleLocationsInfoEXT> consumer)

Passes the sampleLocationsInfo field to the specified Consumer.

setback to summary
public VkSubpassSampleLocationsEXT set(int subpassIndex, VkSampleLocationsInfoEXT sampleLocationsInfo)

Initializes this struct with the specified values.

setback to summary
public VkSubpassSampleLocationsEXT set(VkSubpassSampleLocationsEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkSubpassSampleLocationsEXT

the source struct

Returns:VkSubpassSampleLocationsEXT

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
subpassIndexback to summary
public int subpassIndex()

the index of the subpass for which the sample locations state is provided.

Annotations
@NativeType:uint32_t
subpassIndexback to summary
public VkSubpassSampleLocationsEXT subpassIndex(int value)

Sets the specified value to the subpassIndex field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkSubpassSampleLocationsEXT.Buffer

extends StructBuffer<VkSubpassSampleLocationsEXT, VkSubpassSampleLocationsEXT.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of VkSubpassSampleLocationsEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkSubpassSampleLocationsEXT
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkSubpassSampleLocationsEXT.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VkSubpassSampleLocationsEXT
getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

public VkSampleLocationsInfoEXT

Returns:

a VkSampleLocationsInfoEXT view of the VkSubpassSampleLocationsEXT#sampleLocationsInfo field.
sampleLocationsInfo()

public VkSubpassSampleLocationsEXT.Buffer
sampleLocationsInfo(VkSampleLocationsInfoEXT value)

Copies the specified VkSampleLocationsInfoEXT to the VkSubpassSampleLocationsEXT#sampleLocationsInfo field.

public VkSubpassSampleLocationsEXT.Buffer
sampleLocationsInfo(Consumer<VkSampleLocationsInfoEXT> consumer)

Passes the VkSubpassSampleLocationsEXT#sampleLocationsInfo field to the specified Consumer.

protected VkSubpassSampleLocationsEXT.Buffer
self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

public int

Returns:

the value of the VkSubpassSampleLocationsEXT#subpassIndex field.
subpassIndex()

public VkSubpassSampleLocationsEXT.Buffer
subpassIndex(int value)

Sets the specified value to the VkSubpassSampleLocationsEXT#subpassIndex field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkSubpassSampleLocationsEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkSubpassSampleLocationsEXT.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkSubpassSampleLocationsEXT#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VkSubpassSampleLocationsEXT getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
sampleLocationsInfoback to summary
public VkSampleLocationsInfoEXT sampleLocationsInfo()
Returns:VkSampleLocationsInfoEXT

a VkSampleLocationsInfoEXT view of the VkSubpassSampleLocationsEXT#sampleLocationsInfo field.

sampleLocationsInfoback to summary
public VkSubpassSampleLocationsEXT.Buffer sampleLocationsInfo(VkSampleLocationsInfoEXT value)

Copies the specified VkSampleLocationsInfoEXT to the VkSubpassSampleLocationsEXT#sampleLocationsInfo field.

sampleLocationsInfoback to summary
public VkSubpassSampleLocationsEXT.Buffer sampleLocationsInfo(Consumer<VkSampleLocationsInfoEXT> consumer)

Passes the VkSubpassSampleLocationsEXT#sampleLocationsInfo field to the specified Consumer.

selfback to summary
protected VkSubpassSampleLocationsEXT.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
subpassIndexback to summary
public int subpassIndex()
Returns:int

the value of the VkSubpassSampleLocationsEXT#subpassIndex field.

Annotations
@NativeType:uint32_t
subpassIndexback to summary
public VkSubpassSampleLocationsEXT.Buffer subpassIndex(int value)

Sets the specified value to the VkSubpassSampleLocationsEXT#subpassIndex field.