VkAttachmentSampleLocationsEXT (LWJGL 3.2.4 SNAPSHOT

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 with IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT then the values specified in sampleLocationsInfo are ignored.

Valid Usage
- attachmentIndex must be less than the attachmentCount specified in VkRenderPassCreateInfo the render pass specified by VkRenderPassBeginInfo::renderPass was created with
Valid Usage (Implicit)
- sampleLocationsInfo must be a valid VkSampleLocationsInfoEXT 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 and Description

static class VkAttachmentSampleLocationsEXT.Buffer
An array of VkAttachmentSampleLocationsEXT structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkAttachmentSampleLocationsEXT.Buffer` An array of `VkAttachmentSampleLocationsEXT` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`ATTACHMENTINDEX` The struct member offsets.
`static int`	`SAMPLELOCATIONSINFO` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkAttachmentSampleLocationsEXT(java.nio.ByteBuffer container)` Creates a `VkAttachmentSampleLocationsEXT` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`attachmentIndex()` Returns the value of the `attachmentIndex` field.
`VkAttachmentSampleLocationsEXT`	`attachmentIndex(int value)` Sets the specified value to the `attachmentIndex` field.
`static VkAttachmentSampleLocationsEXT`	`calloc()` Returns a new `VkAttachmentSampleLocationsEXT` instance allocated with `memCalloc`.
`static VkAttachmentSampleLocationsEXT.Buffer`	`calloc(int capacity)` Returns a new `VkAttachmentSampleLocationsEXT.Buffer` instance allocated with `memCalloc`.
`static VkAttachmentSampleLocationsEXT`	`callocStack()` Returns a new `VkAttachmentSampleLocationsEXT` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkAttachmentSampleLocationsEXT.Buffer`	`callocStack(int capacity)` Returns a new `VkAttachmentSampleLocationsEXT.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkAttachmentSampleLocationsEXT.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkAttachmentSampleLocationsEXT.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkAttachmentSampleLocationsEXT`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkAttachmentSampleLocationsEXT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkAttachmentSampleLocationsEXT`	`create()` Returns a new `VkAttachmentSampleLocationsEXT` instance allocated with `BufferUtils`.
`static VkAttachmentSampleLocationsEXT.Buffer`	`create(int capacity)` Returns a new `VkAttachmentSampleLocationsEXT.Buffer` instance allocated with `BufferUtils`.
`static VkAttachmentSampleLocationsEXT`	`create(long address)` Returns a new `VkAttachmentSampleLocationsEXT` instance for the specified memory address.
`static VkAttachmentSampleLocationsEXT.Buffer`	`create(long address, int capacity)` Create a `VkAttachmentSampleLocationsEXT.Buffer` instance at the specified memory.
`static VkAttachmentSampleLocationsEXT`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkAttachmentSampleLocationsEXT.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkAttachmentSampleLocationsEXT`	`malloc()` Returns a new `VkAttachmentSampleLocationsEXT` instance allocated with `memAlloc`.
`static VkAttachmentSampleLocationsEXT.Buffer`	`malloc(int capacity)` Returns a new `VkAttachmentSampleLocationsEXT.Buffer` instance allocated with `memAlloc`.
`static VkAttachmentSampleLocationsEXT`	`mallocStack()` Returns a new `VkAttachmentSampleLocationsEXT` instance allocated on the thread-local `MemoryStack`.
`static VkAttachmentSampleLocationsEXT.Buffer`	`mallocStack(int capacity)` Returns a new `VkAttachmentSampleLocationsEXT.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkAttachmentSampleLocationsEXT.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkAttachmentSampleLocationsEXT.Buffer` instance allocated on the specified `MemoryStack`.
`static VkAttachmentSampleLocationsEXT`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkAttachmentSampleLocationsEXT` instance allocated on the specified `MemoryStack`.
`static int`	`nattachmentIndex(long struct)` Unsafe version of `attachmentIndex()`.
`static void`	`nattachmentIndex(long struct, int value)` Unsafe version of `attachmentIndex`.
`static VkSampleLocationsInfoEXT`	`nsampleLocationsInfo(long struct)` Unsafe version of `sampleLocationsInfo()`.
`static void`	`nsampleLocationsInfo(long struct, VkSampleLocationsInfoEXT value)` Unsafe version of `sampleLocationsInfo`.
`VkSampleLocationsInfoEXT`	`sampleLocationsInfo()` Returns a `VkSampleLocationsInfoEXT` view of the `sampleLocationsInfo` field.
`VkAttachmentSampleLocationsEXT`	`sampleLocationsInfo(java.util.function.Consumer<VkSampleLocationsInfoEXT> consumer)` Passes the `sampleLocationsInfo` field to the specified `Consumer`.
`VkAttachmentSampleLocationsEXT`	`sampleLocationsInfo(VkSampleLocationsInfoEXT value)` Copies the specified `VkSampleLocationsInfoEXT` to the `sampleLocationsInfo` 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 be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - ATTACHMENTINDEX
```
public static final int ATTACHMENTINDEX
```
    The struct member offsets.
  - SAMPLELOCATIONSINFO
```
public static final int SAMPLELOCATIONSINFO
```
    The struct member offsets.
- Constructor Detail
  - VkAttachmentSampleLocationsEXT
```
public VkAttachmentSampleLocationsEXT(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - attachmentIndex
```
public int attachmentIndex()
```
    Returns the value of the attachmentIndex field.
  - sampleLocationsInfo
```
public VkSampleLocationsInfoEXT sampleLocationsInfo()
```
    Returns a VkSampleLocationsInfoEXT view of the sampleLocationsInfo field.
  - attachmentIndex
```
public VkAttachmentSampleLocationsEXT attachmentIndex(int value)
```
    Sets the specified value to the attachmentIndex field.
  - sampleLocationsInfo
```
public VkAttachmentSampleLocationsEXT sampleLocationsInfo(VkSampleLocationsInfoEXT value)
```
    Copies the specified VkSampleLocationsInfoEXT to the sampleLocationsInfo field.
  - sampleLocationsInfo
```
public VkAttachmentSampleLocationsEXT sampleLocationsInfo(java.util.function.Consumer<VkSampleLocationsInfoEXT> consumer)
```
    Passes the sampleLocationsInfo field to the specified Consumer.
  - 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 new VkAttachmentSampleLocationsEXT instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkAttachmentSampleLocationsEXT calloc()
```
    Returns a new VkAttachmentSampleLocationsEXT instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkAttachmentSampleLocationsEXT create()
```
    Returns a new VkAttachmentSampleLocationsEXT instance allocated with BufferUtils.
  - create
```
public static VkAttachmentSampleLocationsEXT create(long address)
```
    Returns a new VkAttachmentSampleLocationsEXT instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkAttachmentSampleLocationsEXT createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkAttachmentSampleLocationsEXT.Buffer malloc(int capacity)
```
    Returns a new VkAttachmentSampleLocationsEXT.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkAttachmentSampleLocationsEXT.Buffer calloc(int capacity)
```
    Returns a new VkAttachmentSampleLocationsEXT.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkAttachmentSampleLocationsEXT.Buffer create(int capacity)
```
    Returns a new VkAttachmentSampleLocationsEXT.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkAttachmentSampleLocationsEXT.Buffer create(long address,
                                                           int capacity)
```
    Create a VkAttachmentSampleLocationsEXT.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkAttachmentSampleLocationsEXT.Buffer createSafe(long address,
                                                                         int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkAttachmentSampleLocationsEXT mallocStack()
```
    Returns a new VkAttachmentSampleLocationsEXT instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkAttachmentSampleLocationsEXT callocStack()
```
    Returns a new VkAttachmentSampleLocationsEXT instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkAttachmentSampleLocationsEXT mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAttachmentSampleLocationsEXT instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkAttachmentSampleLocationsEXT callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAttachmentSampleLocationsEXT instance allocated on the specified MemoryStack 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 new VkAttachmentSampleLocationsEXT.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkAttachmentSampleLocationsEXT.Buffer callocStack(int capacity)
```
    Returns a new VkAttachmentSampleLocationsEXT.Buffer instance allocated on the thread-local MemoryStack 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 new VkAttachmentSampleLocationsEXT.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkAttachmentSampleLocationsEXT.Buffer callocStack(int capacity,
                                                                org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAttachmentSampleLocationsEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nattachmentIndex
```
public static int nattachmentIndex(long struct)
```
    Unsafe version of attachmentIndex().
  - nsampleLocationsInfo
```
public static VkSampleLocationsInfoEXT nsampleLocationsInfo(long struct)
```
    Unsafe version of sampleLocationsInfo().
  - nattachmentIndex
```
public static void nattachmentIndex(long struct,
                                    int value)
```
    Unsafe version of attachmentIndex.
  - nsampleLocationsInfo
```
public static void nsampleLocationsInfo(long struct,
                                        VkSampleLocationsInfoEXT value)
```
    Unsafe version of sampleLocationsInfo.
  - validate
```
public static void validate(long struct)
```
    Validates pointer members that should not be NULL.
    
    Parameters:
    
    struct - the struct to validate
  - validate
```
public static void validate(long array,
                            int count)
```
    Calls validate(long) for each struct contained in the specified struct array.
    
    Parameters:
    
    array - the struct array to validate
    
    count - the number of structs in array

Class VkAttachmentSampleLocationsEXT

Description

Valid Usage

Valid Usage (Implicit)

See Also

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

ATTACHMENTINDEX

SAMPLELOCATIONSINFO

Constructor Detail

VkAttachmentSampleLocationsEXT

Method Detail

sizeof

attachmentIndex

sampleLocationsInfo

attachmentIndex

sampleLocationsInfo

sampleLocationsInfo

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nattachmentIndex

nsampleLocationsInfo

nattachmentIndex

nsampleLocationsInfo

validate

validate