VkSampleLocationsInfoEXT (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkSampleLocationsInfoEXT

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkSampleLocationsInfoEXT
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying a set of sample locations.
Description

This structure can be used either to specify the sample locations to be used for rendering or to specify the set of sample locations an image subresource has been last rendered with for the purposes of layout transitions of depth/stencil images created with IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT.

The sample locations in pSampleLocations specify sampleLocationsPerPixel number of sample locations for each pixel in the grid of the size specified in sampleLocationGridSize. The sample location for sample i at the pixel grid location (x,y) is taken from pSampleLocations[(x + y sampleLocationGridSize.width) sampleLocationsPerPixel + i].

If the render pass has a fragment density map, the implementation will choose the sample locations for the fragment and the contents of pSampleLocations may be ignored.

Valid Usage
- sampleLocationsPerPixel must be a bit value that is set in VkPhysicalDeviceSampleLocationsPropertiesEXT::sampleLocationSampleCounts
- sampleLocationsCount must equal sampleLocationsPerPixel × sampleLocationGridSize.width × sampleLocationGridSize.height
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_SAMPLE_LOCATIONS_INFO_EXT
- If sampleLocationsPerPixel is not 0, sampleLocationsPerPixel must be a valid VkSampleCountFlagBits value
- If sampleLocationsCount is not 0, pSampleLocations must be a valid pointer to an array of sampleLocationsCount VkSampleLocationEXT structures
See Also

VkAttachmentSampleLocationsEXT, VkExtent2D, VkPipelineSampleLocationsStateCreateInfoEXT, VkSampleLocationEXT, VkSubpassSampleLocationsEXT, CmdSetSampleLocationsEXT

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- sampleLocationsPerPixel – a VkSampleCountFlagBits specifying the number of sample locations per pixel.
- sampleLocationGridSize – the size of the sample location grid to select custom sample locations for.
- sampleLocationsCount – the number of sample locations in pSampleLocations.
- pSampleLocations – a pointer to an array of sampleLocationsCount VkSampleLocationEXT structures.
Layout
```
 struct VkSampleLocationsInfoEXT {
     VkStructureType sType;
     void const * pNext;
     VkSampleCountFlagBits sampleLocationsPerPixel;
     VkExtent2D sampleLocationGridSize;
     uint32_t sampleLocationsCount;
     VkSampleLocationEXT const * pSampleLocations;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`PNEXT` The struct member offsets.
`static int`	`PSAMPLELOCATIONS` The struct member offsets.
`static int`	`SAMPLELOCATIONGRIDSIZE` The struct member offsets.
`static int`	`SAMPLELOCATIONSCOUNT` The struct member offsets.
`static int`	`SAMPLELOCATIONSPERPIXEL` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STYPE` 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
`VkSampleLocationsInfoEXT(java.nio.ByteBuffer container)` Creates a `VkSampleLocationsInfoEXT` 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 VkSampleLocationsInfoEXT`	`calloc()` Returns a new `VkSampleLocationsInfoEXT` instance allocated with `memCalloc`.
`static VkSampleLocationsInfoEXT.Buffer`	`calloc(int capacity)` Returns a new `VkSampleLocationsInfoEXT.Buffer` instance allocated with `memCalloc`.
`static VkSampleLocationsInfoEXT`	`callocStack()` Returns a new `VkSampleLocationsInfoEXT` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkSampleLocationsInfoEXT.Buffer`	`callocStack(int capacity)` Returns a new `VkSampleLocationsInfoEXT.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkSampleLocationsInfoEXT.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkSampleLocationsInfoEXT.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSampleLocationsInfoEXT`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkSampleLocationsInfoEXT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSampleLocationsInfoEXT`	`create()` Returns a new `VkSampleLocationsInfoEXT` instance allocated with `BufferUtils`.
`static VkSampleLocationsInfoEXT.Buffer`	`create(int capacity)` Returns a new `VkSampleLocationsInfoEXT.Buffer` instance allocated with `BufferUtils`.
`static VkSampleLocationsInfoEXT`	`create(long address)` Returns a new `VkSampleLocationsInfoEXT` instance for the specified memory address.
`static VkSampleLocationsInfoEXT.Buffer`	`create(long address, int capacity)` Create a `VkSampleLocationsInfoEXT.Buffer` instance at the specified memory.
`static VkSampleLocationsInfoEXT`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkSampleLocationsInfoEXT.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkSampleLocationsInfoEXT`	`malloc()` Returns a new `VkSampleLocationsInfoEXT` instance allocated with `memAlloc`.
`static VkSampleLocationsInfoEXT.Buffer`	`malloc(int capacity)` Returns a new `VkSampleLocationsInfoEXT.Buffer` instance allocated with `memAlloc`.
`static VkSampleLocationsInfoEXT`	`mallocStack()` Returns a new `VkSampleLocationsInfoEXT` instance allocated on the thread-local `MemoryStack`.
`static VkSampleLocationsInfoEXT.Buffer`	`mallocStack(int capacity)` Returns a new `VkSampleLocationsInfoEXT.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkSampleLocationsInfoEXT.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkSampleLocationsInfoEXT.Buffer` instance allocated on the specified `MemoryStack`.
`static VkSampleLocationsInfoEXT`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkSampleLocationsInfoEXT` instance allocated on the specified `MemoryStack`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static VkSampleLocationEXT.Buffer`	`npSampleLocations(long struct)` Unsafe version of `pSampleLocations()`.
`static void`	`npSampleLocations(long struct, VkSampleLocationEXT.Buffer value)` Unsafe version of `pSampleLocations`.
`static VkExtent2D`	`nsampleLocationGridSize(long struct)` Unsafe version of `sampleLocationGridSize()`.
`static void`	`nsampleLocationGridSize(long struct, VkExtent2D value)` Unsafe version of `sampleLocationGridSize`.
`static int`	`nsampleLocationsCount(long struct)` Unsafe version of `sampleLocationsCount()`.
`static void`	`nsampleLocationsCount(long struct, int value)` Sets the specified value to the `sampleLocationsCount` field of the specified `struct`.
`static int`	`nsampleLocationsPerPixel(long struct)` Unsafe version of `sampleLocationsPerPixel()`.
`static void`	`nsampleLocationsPerPixel(long struct, int value)` Unsafe version of `sampleLocationsPerPixel`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkSampleLocationsInfoEXT`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkSampleLocationEXT.Buffer`	`pSampleLocations()` Returns a `VkSampleLocationEXT.Buffer` view of the struct array pointed to by the `pSampleLocations` field.
`VkSampleLocationsInfoEXT`	`pSampleLocations(VkSampleLocationEXT.Buffer value)` Sets the address of the specified `VkSampleLocationEXT.Buffer` to the `pSampleLocations` field.
`VkExtent2D`	`sampleLocationGridSize()` Returns a `VkExtent2D` view of the `sampleLocationGridSize` field.
`VkSampleLocationsInfoEXT`	`sampleLocationGridSize(java.util.function.Consumer<VkExtent2D> consumer)` Passes the `sampleLocationGridSize` field to the specified `Consumer`.
`VkSampleLocationsInfoEXT`	`sampleLocationGridSize(VkExtent2D value)` Copies the specified `VkExtent2D` to the `sampleLocationGridSize` field.
`int`	`sampleLocationsCount()` Returns the value of the `sampleLocationsCount` field.
`int`	`sampleLocationsPerPixel()` Returns the value of the `sampleLocationsPerPixel` field.
`VkSampleLocationsInfoEXT`	`sampleLocationsPerPixel(int value)` Sets the specified value to the `sampleLocationsPerPixel` field.
`VkSampleLocationsInfoEXT`	`set(int sType, long pNext, int sampleLocationsPerPixel, VkExtent2D sampleLocationGridSize, VkSampleLocationEXT.Buffer pSampleLocations)` Initializes this struct with the specified values.
`VkSampleLocationsInfoEXT`	`set(VkSampleLocationsInfoEXT src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkSampleLocationsInfoEXT`	`sType(int value)` Sets the specified value to the `sType` 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.
  - STYPE
```
public static final int STYPE
```
    The struct member offsets.
  - PNEXT
```
public static final int PNEXT
```
    The struct member offsets.
  - SAMPLELOCATIONSPERPIXEL
```
public static final int SAMPLELOCATIONSPERPIXEL
```
    The struct member offsets.
  - SAMPLELOCATIONGRIDSIZE
```
public static final int SAMPLELOCATIONGRIDSIZE
```
    The struct member offsets.
  - SAMPLELOCATIONSCOUNT
```
public static final int SAMPLELOCATIONSCOUNT
```
    The struct member offsets.
  - PSAMPLELOCATIONS
```
public static final int PSAMPLELOCATIONS
```
    The struct member offsets.
- Constructor Detail
  - VkSampleLocationsInfoEXT
```
public VkSampleLocationsInfoEXT(java.nio.ByteBuffer container)
```
    Creates a VkSampleLocationsInfoEXT 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
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - sampleLocationsPerPixel
```
public int sampleLocationsPerPixel()
```
    Returns the value of the sampleLocationsPerPixel field.
  - sampleLocationGridSize
```
public VkExtent2D sampleLocationGridSize()
```
    Returns a VkExtent2D view of the sampleLocationGridSize field.
  - sampleLocationsCount
```
public int sampleLocationsCount()
```
    Returns the value of the sampleLocationsCount field.
  - pSampleLocations
```
@Nullable
public VkSampleLocationEXT.Buffer pSampleLocations()
```
    Returns a VkSampleLocationEXT.Buffer view of the struct array pointed to by the pSampleLocations field.
  - sType
```
public VkSampleLocationsInfoEXT sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkSampleLocationsInfoEXT pNext(long value)
```
    Sets the specified value to the pNext field.
  - sampleLocationsPerPixel
```
public VkSampleLocationsInfoEXT sampleLocationsPerPixel(int value)
```
    Sets the specified value to the sampleLocationsPerPixel field.
  - sampleLocationGridSize
```
public VkSampleLocationsInfoEXT sampleLocationGridSize(VkExtent2D value)
```
    Copies the specified VkExtent2D to the sampleLocationGridSize field.
  - sampleLocationGridSize
```
public VkSampleLocationsInfoEXT sampleLocationGridSize(java.util.function.Consumer<VkExtent2D> consumer)
```
    Passes the sampleLocationGridSize field to the specified Consumer.
  - pSampleLocations
```
public VkSampleLocationsInfoEXT pSampleLocations(@Nullable
                                                 VkSampleLocationEXT.Buffer value)
```
    Sets the address of the specified VkSampleLocationEXT.Buffer to the pSampleLocations field.
  - set
```
public VkSampleLocationsInfoEXT set(int sType,
                                    long pNext,
                                    int sampleLocationsPerPixel,
                                    VkExtent2D sampleLocationGridSize,
                                    @Nullable
                                    VkSampleLocationEXT.Buffer pSampleLocations)
```
    Initializes this struct with the specified values.
  - set
```
public VkSampleLocationsInfoEXT set(VkSampleLocationsInfoEXT src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkSampleLocationsInfoEXT malloc()
```
    Returns a new VkSampleLocationsInfoEXT instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkSampleLocationsInfoEXT calloc()
```
    Returns a new VkSampleLocationsInfoEXT instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkSampleLocationsInfoEXT create()
```
    Returns a new VkSampleLocationsInfoEXT instance allocated with BufferUtils.
  - create
```
public static VkSampleLocationsInfoEXT create(long address)
```
    Returns a new VkSampleLocationsInfoEXT instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkSampleLocationsInfoEXT createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkSampleLocationsInfoEXT.Buffer malloc(int capacity)
```
    Returns a new VkSampleLocationsInfoEXT.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkSampleLocationsInfoEXT.Buffer calloc(int capacity)
```
    Returns a new VkSampleLocationsInfoEXT.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkSampleLocationsInfoEXT.Buffer create(int capacity)
```
    Returns a new VkSampleLocationsInfoEXT.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkSampleLocationsInfoEXT.Buffer create(long address,
                                                     int capacity)
```
    Create a VkSampleLocationsInfoEXT.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkSampleLocationsInfoEXT.Buffer createSafe(long address,
                                                                   int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkSampleLocationsInfoEXT mallocStack()
```
    Returns a new VkSampleLocationsInfoEXT instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkSampleLocationsInfoEXT callocStack()
```
    Returns a new VkSampleLocationsInfoEXT instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkSampleLocationsInfoEXT mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSampleLocationsInfoEXT instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkSampleLocationsInfoEXT callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSampleLocationsInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkSampleLocationsInfoEXT.Buffer mallocStack(int capacity)
```
    Returns a new VkSampleLocationsInfoEXT.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkSampleLocationsInfoEXT.Buffer callocStack(int capacity)
```
    Returns a new VkSampleLocationsInfoEXT.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkSampleLocationsInfoEXT.Buffer mallocStack(int capacity,
                                                          org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSampleLocationsInfoEXT.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkSampleLocationsInfoEXT.Buffer callocStack(int capacity,
                                                          org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSampleLocationsInfoEXT.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
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - nsampleLocationsPerPixel
```
public static int nsampleLocationsPerPixel(long struct)
```
    Unsafe version of sampleLocationsPerPixel().
  - nsampleLocationGridSize
```
public static VkExtent2D nsampleLocationGridSize(long struct)
```
    Unsafe version of sampleLocationGridSize().
  - nsampleLocationsCount
```
public static int nsampleLocationsCount(long struct)
```
    Unsafe version of sampleLocationsCount().
  - npSampleLocations
```
@Nullable
public static VkSampleLocationEXT.Buffer npSampleLocations(long struct)
```
    Unsafe version of pSampleLocations().
  - nsType
```
public static void nsType(long struct,
                          int value)
```
    Unsafe version of sType.
  - npNext
```
public static void npNext(long struct,
                          long value)
```
    Unsafe version of pNext.
  - nsampleLocationsPerPixel
```
public static void nsampleLocationsPerPixel(long struct,
                                            int value)
```
    Unsafe version of sampleLocationsPerPixel.
  - nsampleLocationGridSize
```
public static void nsampleLocationGridSize(long struct,
                                           VkExtent2D value)
```
    Unsafe version of sampleLocationGridSize.
  - nsampleLocationsCount
```
public static void nsampleLocationsCount(long struct,
                                         int value)
```
    Sets the specified value to the sampleLocationsCount field of the specified struct.
  - npSampleLocations
```
public static void npSampleLocations(long struct,
                                     @Nullable
                                     VkSampleLocationEXT.Buffer value)
```
    Unsafe version of pSampleLocations.
  - 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 VkSampleLocationsInfoEXT

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

STYPE

PNEXT

SAMPLELOCATIONSPERPIXEL

SAMPLELOCATIONGRIDSIZE

SAMPLELOCATIONSCOUNT

PSAMPLELOCATIONS

Constructor Detail

VkSampleLocationsInfoEXT

Method Detail

sizeof

sType

pNext

sampleLocationsPerPixel

sampleLocationGridSize

sampleLocationsCount

pSampleLocations

sType

pNext

sampleLocationsPerPixel

sampleLocationGridSize

sampleLocationGridSize

pSampleLocations

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nsampleLocationsPerPixel

nsampleLocationGridSize

nsampleLocationsCount

npSampleLocations

nsType

npNext

nsampleLocationsPerPixel

nsampleLocationGridSize

nsampleLocationsCount

npSampleLocations

validate

validate