VkSubpassSampleLocationsEXT (LWJGL 3.2.4 SNAPSHOT

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.NativeResource
```
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
- subpassIndex must be less than the subpassCount 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
- 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 in subpassIndex.
Layout
```
 struct VkSubpassSampleLocationsEXT {
     uint32_t subpassIndex;
     VkSampleLocationsInfoEXT sampleLocationsInfo;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkSubpassSampleLocationsEXT.Buffer
An array of VkSubpassSampleLocationsEXT 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`	`VkSubpassSampleLocationsEXT.Buffer` An array of `VkSubpassSampleLocationsEXT` structs.

Field Summary

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

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

Constructor Summary

Constructors
Constructor and Description
`VkSubpassSampleLocationsEXT(java.nio.ByteBuffer container)` Creates a `VkSubpassSampleLocationsEXT` 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
`static VkSubpassSampleLocationsEXT`	`calloc()` Returns a new `VkSubpassSampleLocationsEXT` instance allocated with `memCalloc`.
`static VkSubpassSampleLocationsEXT.Buffer`	`calloc(int capacity)` Returns a new `VkSubpassSampleLocationsEXT.Buffer` instance allocated with `memCalloc`.
`static VkSubpassSampleLocationsEXT`	`callocStack()` Returns a new `VkSubpassSampleLocationsEXT` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkSubpassSampleLocationsEXT.Buffer`	`callocStack(int capacity)` Returns a new `VkSubpassSampleLocationsEXT.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkSubpassSampleLocationsEXT.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkSubpassSampleLocationsEXT.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSubpassSampleLocationsEXT`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkSubpassSampleLocationsEXT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSubpassSampleLocationsEXT`	`create()` Returns a new `VkSubpassSampleLocationsEXT` instance allocated with `BufferUtils`.
`static VkSubpassSampleLocationsEXT.Buffer`	`create(int capacity)` Returns a new `VkSubpassSampleLocationsEXT.Buffer` instance allocated with `BufferUtils`.
`static VkSubpassSampleLocationsEXT`	`create(long address)` Returns a new `VkSubpassSampleLocationsEXT` instance for the specified memory address.
`static VkSubpassSampleLocationsEXT.Buffer`	`create(long address, int capacity)` Create a `VkSubpassSampleLocationsEXT.Buffer` instance at the specified memory.
`static VkSubpassSampleLocationsEXT`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkSubpassSampleLocationsEXT.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkSubpassSampleLocationsEXT`	`malloc()` Returns a new `VkSubpassSampleLocationsEXT` instance allocated with `memAlloc`.
`static VkSubpassSampleLocationsEXT.Buffer`	`malloc(int capacity)` Returns a new `VkSubpassSampleLocationsEXT.Buffer` instance allocated with `memAlloc`.
`static VkSubpassSampleLocationsEXT`	`mallocStack()` Returns a new `VkSubpassSampleLocationsEXT` instance allocated on the thread-local `MemoryStack`.
`static VkSubpassSampleLocationsEXT.Buffer`	`mallocStack(int capacity)` Returns a new `VkSubpassSampleLocationsEXT.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkSubpassSampleLocationsEXT.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkSubpassSampleLocationsEXT.Buffer` instance allocated on the specified `MemoryStack`.
`static VkSubpassSampleLocationsEXT`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkSubpassSampleLocationsEXT` instance allocated on the specified `MemoryStack`.
`static VkSampleLocationsInfoEXT`	`nsampleLocationsInfo(long struct)` Unsafe version of `sampleLocationsInfo()`.
`static void`	`nsampleLocationsInfo(long struct, VkSampleLocationsInfoEXT value)` Unsafe version of `sampleLocationsInfo`.
`static int`	`nsubpassIndex(long struct)` Unsafe version of `subpassIndex()`.
`static void`	`nsubpassIndex(long struct, int value)` Unsafe version of `subpassIndex`.
`VkSampleLocationsInfoEXT`	`sampleLocationsInfo()` Returns a `VkSampleLocationsInfoEXT` view of the `sampleLocationsInfo` field.
`VkSubpassSampleLocationsEXT`	`sampleLocationsInfo(java.util.function.Consumer<VkSampleLocationsInfoEXT> consumer)` Passes the `sampleLocationsInfo` field to the specified `Consumer`.
`VkSubpassSampleLocationsEXT`	`sampleLocationsInfo(VkSampleLocationsInfoEXT value)` Copies the specified `VkSampleLocationsInfoEXT` to the `sampleLocationsInfo` field.
`VkSubpassSampleLocationsEXT`	`set(int subpassIndex, VkSampleLocationsInfoEXT sampleLocationsInfo)` Initializes this struct with the specified values.
`VkSubpassSampleLocationsEXT`	`set(VkSubpassSampleLocationsEXT src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`subpassIndex()` Returns the value of the `subpassIndex` field.
`VkSubpassSampleLocationsEXT`	`subpassIndex(int value)` Sets the specified value to the `subpassIndex` field.
`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.
  - SUBPASSINDEX
```
public static final int SUBPASSINDEX
```
    The struct member offsets.
  - SAMPLELOCATIONSINFO
```
public static final int SAMPLELOCATIONSINFO
```
    The struct member offsets.
- Constructor Detail
  - VkSubpassSampleLocationsEXT
```
public VkSubpassSampleLocationsEXT(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - subpassIndex
```
public int subpassIndex()
```
    Returns the value of the subpassIndex field.
  - sampleLocationsInfo
```
public VkSampleLocationsInfoEXT sampleLocationsInfo()
```
    Returns a VkSampleLocationsInfoEXT view of the sampleLocationsInfo field.
  - subpassIndex
```
public VkSubpassSampleLocationsEXT subpassIndex(int value)
```
    Sets the specified value to the subpassIndex field.
  - sampleLocationsInfo
```
public VkSubpassSampleLocationsEXT sampleLocationsInfo(VkSampleLocationsInfoEXT value)
```
    Copies the specified VkSampleLocationsInfoEXT to the sampleLocationsInfo field.
  - sampleLocationsInfo
```
public VkSubpassSampleLocationsEXT sampleLocationsInfo(java.util.function.Consumer<VkSampleLocationsInfoEXT> consumer)
```
    Passes the sampleLocationsInfo field to the specified Consumer.
  - 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 new VkSubpassSampleLocationsEXT instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkSubpassSampleLocationsEXT calloc()
```
    Returns a new VkSubpassSampleLocationsEXT instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkSubpassSampleLocationsEXT create()
```
    Returns a new VkSubpassSampleLocationsEXT instance allocated with BufferUtils.
  - create
```
public static VkSubpassSampleLocationsEXT create(long address)
```
    Returns a new VkSubpassSampleLocationsEXT instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkSubpassSampleLocationsEXT createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkSubpassSampleLocationsEXT.Buffer malloc(int capacity)
```
    Returns a new VkSubpassSampleLocationsEXT.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkSubpassSampleLocationsEXT.Buffer calloc(int capacity)
```
    Returns a new VkSubpassSampleLocationsEXT.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkSubpassSampleLocationsEXT.Buffer create(int capacity)
```
    Returns a new VkSubpassSampleLocationsEXT.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkSubpassSampleLocationsEXT.Buffer create(long address,
                                                        int capacity)
```
    Create a VkSubpassSampleLocationsEXT.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkSubpassSampleLocationsEXT.Buffer createSafe(long address,
                                                                      int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkSubpassSampleLocationsEXT mallocStack()
```
    Returns a new VkSubpassSampleLocationsEXT instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkSubpassSampleLocationsEXT callocStack()
```
    Returns a new VkSubpassSampleLocationsEXT instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkSubpassSampleLocationsEXT mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSubpassSampleLocationsEXT instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkSubpassSampleLocationsEXT callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSubpassSampleLocationsEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkSubpassSampleLocationsEXT.Buffer mallocStack(int capacity)
```
    Returns a new VkSubpassSampleLocationsEXT.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkSubpassSampleLocationsEXT.Buffer callocStack(int capacity)
```
    Returns a new VkSubpassSampleLocationsEXT.Buffer instance allocated on the thread-local MemoryStack and 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 new VkSubpassSampleLocationsEXT.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkSubpassSampleLocationsEXT.Buffer callocStack(int capacity,
                                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSubpassSampleLocationsEXT.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
  - nsubpassIndex
```
public static int nsubpassIndex(long struct)
```
    Unsafe version of subpassIndex().
  - nsampleLocationsInfo
```
public static VkSampleLocationsInfoEXT nsampleLocationsInfo(long struct)
```
    Unsafe version of sampleLocationsInfo().
  - nsubpassIndex
```
public static void nsubpassIndex(long struct,
                                 int value)
```
    Unsafe version of subpassIndex.
  - 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 VkSubpassSampleLocationsEXT

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

SUBPASSINDEX

SAMPLELOCATIONSINFO

Constructor Detail

VkSubpassSampleLocationsEXT

Method Detail

sizeof

subpassIndex

sampleLocationsInfo

subpassIndex

sampleLocationsInfo

sampleLocationsInfo

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsubpassIndex

nsampleLocationsInfo

nsubpassIndex

nsampleLocationsInfo

validate

validate