Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkAttachmentSampleLocationsEXT

extends Struct<VkAttachmentSampleLocationsEXT>
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 in the initial layout transition of attachments.
Description

If the image referenced by the framebuffer attachment at index attachmentIndex was not created with IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT then the values specified in sampleLocationsInfo are ignored.

Valid Usage
Valid Usage (Implicit)
See Also

VkRenderPassSampleLocationsBeginInfoEXT, VkSampleLocationsInfoEXT

Layout


struct VkAttachmentSampleLocationsEXT {
    uint32_t attachmentIndex;
    VkSampleLocationsInfoEXT sampleLocationsInfo;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkAttachmentSampleLocationsEXT.Buffer

An array of VkAttachmentSampleLocationsEXT structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
ATTACHMENTINDEX

The struct member offsets.

public static final int
SAMPLELOCATIONSINFO

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkAttachmentSampleLocationsEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public int
attachmentIndex()

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

public VkAttachmentSampleLocationsEXT
attachmentIndex(int value)

Sets the specified value to the attachmentIndex field.

public static VkAttachmentSampleLocationsEXT
calloc()

Returns a new VkAttachmentSampleLocationsEXT instance allocated with memCalloc.

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

Returns a new VkAttachmentSampleLocationsEXT.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkAttachmentSampleLocationsEXT
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
protected VkAttachmentSampleLocationsEXT
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 VkAttachmentSampleLocationsEXT
create()

Returns a new VkAttachmentSampleLocationsEXT instance allocated with BufferUtils.

public static VkAttachmentSampleLocationsEXT
create(long address)

Returns a new VkAttachmentSampleLocationsEXT instance for the specified memory address.

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

Returns a new VkAttachmentSampleLocationsEXT.Buffer instance allocated with BufferUtils.

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

Create a VkAttachmentSampleLocationsEXT.Buffer instance at the specified memory.

public static VkAttachmentSampleLocationsEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkAttachmentSampleLocationsEXT
malloc()

Returns a new VkAttachmentSampleLocationsEXT instance allocated with memAlloc.

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

Returns a new VkAttachmentSampleLocationsEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkAttachmentSampleLocationsEXT instance allocated on the specified MemoryStack.

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

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

public static VkAttachmentSampleLocationsEXT
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static int
nattachmentIndex(long struct)

Unsafe version of attachmentIndex.

public static void
nattachmentIndex(long struct, int value)

Unsafe version of attachmentIndex.

public static VkSampleLocationsInfoEXT
nsampleLocationsInfo(long struct)

Unsafe version of sampleLocationsInfo.

public static void
nsampleLocationsInfo(long struct, VkSampleLocationsInfoEXT value)

Unsafe version of 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.

public VkAttachmentSampleLocationsEXT
sampleLocationsInfo(VkSampleLocationsInfoEXT value)

Copies the specified VkSampleLocationsInfoEXT to the sampleLocationsInfo field.

public VkAttachmentSampleLocationsEXT
sampleLocationsInfo(Consumer<VkSampleLocationsInfoEXT> consumer)

Passes the sampleLocationsInfo field to the specified Consumer.

public VkAttachmentSampleLocationsEXT
set(int attachmentIndex, VkSampleLocationsInfoEXT sampleLocationsInfo)

Initializes this struct with the specified values.

public VkAttachmentSampleLocationsEXT

Returns:

this struct
set(VkAttachmentSampleLocationsEXT
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 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.

ATTACHMENTINDEXback to summary
public static final int ATTACHMENTINDEX

The struct member offsets.

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.

Constructor Detail

VkAttachmentSampleLocationsEXTback to summary
protected VkAttachmentSampleLocationsEXT(long address, ByteBuffer container)
VkAttachmentSampleLocationsEXTback to summary
public VkAttachmentSampleLocationsEXT(ByteBuffer container)

Creates a VkAttachmentSampleLocationsEXT 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

attachmentIndexback to summary
public int attachmentIndex()

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

Annotations
@NativeType:uint32_t
attachmentIndexback to summary
public VkAttachmentSampleLocationsEXT attachmentIndex(int value)

Sets the specified value to the attachmentIndex field.

callocback to summary
public static VkAttachmentSampleLocationsEXT calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkAttachmentSampleLocationsEXT calloc(MemoryStack stack)

Returns a new VkAttachmentSampleLocationsEXT 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 VkAttachmentSampleLocationsEXT.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkAttachmentSampleLocationsEXT.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 VkAttachmentSampleLocationsEXT callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkAttachmentSampleLocationsEXT.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 VkAttachmentSampleLocationsEXT 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 VkAttachmentSampleLocationsEXT create()

Returns a new VkAttachmentSampleLocationsEXT instance allocated with BufferUtils.

createback to summary
public static VkAttachmentSampleLocationsEXT create(long address)

Returns a new VkAttachmentSampleLocationsEXT instance for the specified memory address.

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

Returns a new VkAttachmentSampleLocationsEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkAttachmentSampleLocationsEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkAttachmentSampleLocationsEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkAttachmentSampleLocationsEXT malloc(MemoryStack stack)

Returns a new VkAttachmentSampleLocationsEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new VkAttachmentSampleLocationsEXT.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 VkAttachmentSampleLocationsEXT mallocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nattachmentIndexback to summary
public static int nattachmentIndex(long struct)

Unsafe version of attachmentIndex.

nattachmentIndexback to summary
public static void nattachmentIndex(long struct, int value)

Unsafe version of attachmentIndex.

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.

sampleLocationsInfoback to summary
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.

sampleLocationsInfoback to summary
public VkAttachmentSampleLocationsEXT sampleLocationsInfo(VkSampleLocationsInfoEXT value)

Copies the specified VkSampleLocationsInfoEXT to the sampleLocationsInfo field.

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

Passes the sampleLocationsInfo field to the specified Consumer.

setback to summary
public VkAttachmentSampleLocationsEXT set(int attachmentIndex, VkSampleLocationsInfoEXT sampleLocationsInfo)

Initializes this struct with the specified values.

setback to summary
public VkAttachmentSampleLocationsEXT set(VkAttachmentSampleLocationsEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkAttachmentSampleLocationsEXT

the source struct

Returns:VkAttachmentSampleLocationsEXT

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
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 VkAttachmentSampleLocationsEXT.Buffer

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

Field Summary

Modifier and TypeField and Description
private static final VkAttachmentSampleLocationsEXT
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkAttachmentSampleLocationsEXT.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
public int

Returns:

the value of the VkAttachmentSampleLocationsEXT#attachmentIndex field.
attachmentIndex()

public VkAttachmentSampleLocationsEXT.Buffer
attachmentIndex(int value)

Sets the specified value to the VkAttachmentSampleLocationsEXT#attachmentIndex field.

protected VkAttachmentSampleLocationsEXT
getElementFactory()

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

public VkSampleLocationsInfoEXT

Returns:

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

public VkAttachmentSampleLocationsEXT.Buffer
sampleLocationsInfo(VkSampleLocationsInfoEXT value)

Copies the specified VkSampleLocationsInfoEXT to the VkAttachmentSampleLocationsEXT#sampleLocationsInfo field.

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

Passes the VkAttachmentSampleLocationsEXT#sampleLocationsInfo field to the specified Consumer.

protected VkAttachmentSampleLocationsEXT.Buffer
self()

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

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkAttachmentSampleLocationsEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkAttachmentSampleLocationsEXT.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 VkAttachmentSampleLocationsEXT#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

attachmentIndexback to summary
public int attachmentIndex()
Returns:int

the value of the VkAttachmentSampleLocationsEXT#attachmentIndex field.

Annotations
@NativeType:uint32_t
attachmentIndexback to summary
public VkAttachmentSampleLocationsEXT.Buffer attachmentIndex(int value)

Sets the specified value to the VkAttachmentSampleLocationsEXT#attachmentIndex field.

getElementFactoryback to summary
protected VkAttachmentSampleLocationsEXT getElementFactory()

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

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

a VkSampleLocationsInfoEXT view of the VkAttachmentSampleLocationsEXT#sampleLocationsInfo field.

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

Copies the specified VkSampleLocationsInfoEXT to the VkAttachmentSampleLocationsEXT#sampleLocationsInfo field.

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

Passes the VkAttachmentSampleLocationsEXT#sampleLocationsInfo field to the specified Consumer.

selfback to summary
protected VkAttachmentSampleLocationsEXT.Buffer self()

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

Annotations
@Override