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 sampleLocationsCount is not 0, pSampleLocations must be a valid 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 and Inner Type Summary

Modifier and Type	Class and Description
public static class	VkSampleLocationsInfoEXT.Buffer An array of `VkSampleLocationsInfoEXT` structs.

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	PNEXT The struct member offsets.
public static final int	PSAMPLELOCATIONS The struct member offsets.
public static final int	SAMPLELOCATIONGRIDSIZE The struct member offsets.
public static final int	SAMPLELOCATIONSCOUNT The struct member offsets.
public static final int	SAMPLELOCATIONSPERPIXEL The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	STYPE The struct member offsets.

Inherited from org.lwjgl.system.Struct:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	VkSampleLocationsInfoEXT(long address, ByteBuffer container)
public	VkSampleLocationsInfoEXT(ByteBuffer container) Creates a `VkSampleLocationsInfoEXT` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static VkSampleLocationsInfoEXT	calloc() Returns a new `VkSampleLocationsInfoEXT` instance allocated with `memCalloc`.
public static VkSampleLocationsInfoEXT.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkSampleLocationsInfoEXT.Buffer` instance allocated with `memCalloc`.
public static VkSampleLocationsInfoEXT	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkSampleLocationsInfoEXT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkSampleLocationsInfoEXT.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkSampleLocationsInfoEXT.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkSampleLocationsInfoEXT	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkSampleLocationsInfoEXT	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkSampleLocationsInfoEXT.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkSampleLocationsInfoEXT.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkSampleLocationsInfoEXT	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 VkSampleLocationsInfoEXT	create() Returns a new `VkSampleLocationsInfoEXT` instance allocated with `BufferUtils`.
public static VkSampleLocationsInfoEXT	create(long address) Returns a new `VkSampleLocationsInfoEXT` instance for the specified memory address.
public static VkSampleLocationsInfoEXT.Buffer	create(int the buffer capacity capacity) Returns a new `VkSampleLocationsInfoEXT.Buffer` instance allocated with `BufferUtils`.
public static VkSampleLocationsInfoEXT.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkSampleLocationsInfoEXT.Buffer` instance at the specified memory.
public static VkSampleLocationsInfoEXT	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkSampleLocationsInfoEXT.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static VkSampleLocationsInfoEXT	malloc() Returns a new `VkSampleLocationsInfoEXT` instance allocated with `memAlloc`.
public static VkSampleLocationsInfoEXT.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkSampleLocationsInfoEXT.Buffer` instance allocated with `memAlloc`.
public static VkSampleLocationsInfoEXT	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkSampleLocationsInfoEXT` instance allocated on the specified `MemoryStack`.
public static VkSampleLocationsInfoEXT.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkSampleLocationsInfoEXT.Buffer` instance allocated on the specified `MemoryStack`.
public static VkSampleLocationsInfoEXT	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkSampleLocationsInfoEXT	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkSampleLocationsInfoEXT.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkSampleLocationsInfoEXT.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static long	npNext(long struct) Unsafe version of `pNext`.
public static void	npNext(long struct, long value) Unsafe version of `pNext`.
public static VkSampleLocationEXT.Buffer	npSampleLocations(long struct) Unsafe version of `pSampleLocations`.
public static void	npSampleLocations(long struct, VkSampleLocationEXT.Buffer value) Unsafe version of `pSampleLocations`.
public static VkExtent2D	nsampleLocationGridSize(long struct) Unsafe version of `sampleLocationGridSize`.
public static void	nsampleLocationGridSize(long struct, VkExtent2D value) Unsafe version of `sampleLocationGridSize`.
public static int	nsampleLocationsCount(long struct) Unsafe version of `sampleLocationsCount`.
public static void	nsampleLocationsCount(long struct, int value) Sets the specified value to the `sampleLocationsCount` field of the specified `struct`.
public static int	nsampleLocationsPerPixel(long struct) Unsafe version of `sampleLocationsPerPixel`.
public static void	nsampleLocationsPerPixel(long struct, int value) Unsafe version of `sampleLocationsPerPixel`.
public static int	nsType(long struct) Unsafe version of `sType`.
public static void	nsType(long struct, int value) Unsafe version of `sType`.
public long	pNext() `NULL` or a pointer to a structure extending this structure.
public VkSampleLocationsInfoEXT	pNext(long value) Sets the specified value to the `pNext` field.
public VkSampleLocationEXT.Buffer	pSampleLocations() a pointer to an array of `sampleLocationsCount` `VkSampleLocationEXT` structures.
public VkSampleLocationsInfoEXT	pSampleLocations(VkSampleLocationEXT.Buffer value) Sets the address of the specified `VkSampleLocationEXT.Buffer` to the `pSampleLocations` field.
public VkExtent2D	sampleLocationGridSize() the size of the sample location grid to select custom sample locations for.
public VkSampleLocationsInfoEXT	sampleLocationGridSize(VkExtent2D value) Copies the specified `VkExtent2D` to the `sampleLocationGridSize` field.
public VkSampleLocationsInfoEXT	sampleLocationGridSize(Consumer<VkExtent2D> consumer) Passes the `sampleLocationGridSize` field to the specified `Consumer`.
public int	sampleLocationsCount() the number of sample locations in `pSampleLocations`.
public int	sampleLocationsPerPixel() a `VkSampleCountFlagBits` value specifying the number of sample locations per pixel.
public VkSampleLocationsInfoEXT	sampleLocationsPerPixel(int value) Sets the specified value to the `sampleLocationsPerPixel` field.
public VkSampleLocationsInfoEXT	set(int sType, long pNext, int sampleLocationsPerPixel, VkExtent2D sampleLocationGridSize, VkSampleLocationEXT.Buffer pSampleLocations) Initializes this struct with the specified values.
public VkSampleLocationsInfoEXT	Returns: this struct set(VkSampleLocationsInfoEXT 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	sType() a `VkStructureType` value identifying this structure.
public VkSampleLocationsInfoEXT	sType(int value) Sets the specified value to the `sType` field.
public VkSampleLocationsInfoEXT	sType$Default() Sets the `STRUCTURE_TYPE_SAMPLE_LOCATIONS_INFO_EXT` value to the `sType` field.
public static void	validate(long the struct to validate struct) Validates pointer members that should not be `NULL`.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

PNEXT	back to summary
public static final int PNEXT The struct member offsets.

PSAMPLELOCATIONS	back to summary
public static final int PSAMPLELOCATIONS The struct member offsets.

SAMPLELOCATIONGRIDSIZE	back to summary
public static final int SAMPLELOCATIONGRIDSIZE The struct member offsets.

SAMPLELOCATIONSCOUNT	back to summary
public static final int SAMPLELOCATIONSCOUNT The struct member offsets.

SAMPLELOCATIONSPERPIXEL	back to summary
public static final int SAMPLELOCATIONSPERPIXEL The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

STYPE	back to summary
public static final int STYPE The struct member offsets.

Constructor Detail

VkSampleLocationsInfoEXT	back to summary
protected VkSampleLocationsInfoEXT(long address, ByteBuffer container)

VkSampleLocationsInfoEXT back to summary

VkSampleLocationsInfoEXT	back to summary
public VkSampleLocationsInfoEXT(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.

public VkSampleLocationsInfoEXT(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

calloc	back to summary
public static VkSampleLocationsInfoEXT calloc() Returns a new `VkSampleLocationsInfoEXT` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static VkSampleLocationsInfoEXT.Buffer calloc(int capacity) Returns a new `VkSampleLocationsInfoEXT.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkSampleLocationsInfoEXT.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static VkSampleLocationsInfoEXT calloc(MemoryStack stack) Returns a new `VkSampleLocationsInfoEXT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkSampleLocationsInfoEXT calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static VkSampleLocationsInfoEXT.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkSampleLocationsInfoEXT.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

public static VkSampleLocationsInfoEXT.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkSampleLocationsInfoEXT.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

callocStack back to summary

callocStack	back to summary
public static VkSampleLocationsInfoEXT callocStack() Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkSampleLocationsInfoEXT callocStack()

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkSampleLocationsInfoEXT callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkSampleLocationsInfoEXT callocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkSampleLocationsInfoEXT.Buffer callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkSampleLocationsInfoEXT.Buffer callocStack(int capacity)

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkSampleLocationsInfoEXT.Buffer callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkSampleLocationsInfoEXT.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

create back to summary

create	back to summary
protected VkSampleLocationsInfoEXT 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

protected VkSampleLocationsInfoEXT 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

create	back to summary
public static VkSampleLocationsInfoEXT create() Returns a new `VkSampleLocationsInfoEXT` instance allocated with `BufferUtils`.

create	back to summary
public static VkSampleLocationsInfoEXT create(long address) Returns a new `VkSampleLocationsInfoEXT` instance for the specified memory address.

create back to summary

create	back to summary
public static VkSampleLocationsInfoEXT.Buffer create(int capacity) Returns a new `VkSampleLocationsInfoEXT.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static VkSampleLocationsInfoEXT.Buffer create(int capacity)

Returns a new VkSampleLocationsInfoEXT.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static VkSampleLocationsInfoEXT.Buffer create(long address, int capacity) Create a `VkSampleLocationsInfoEXT.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

public static VkSampleLocationsInfoEXT.Buffer create(long address, int capacity)

Create a VkSampleLocationsInfoEXT.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static VkSampleLocationsInfoEXT createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkSampleLocationsInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static VkSampleLocationsInfoEXT.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

malloc	back to summary
public static VkSampleLocationsInfoEXT malloc() Returns a new `VkSampleLocationsInfoEXT` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static VkSampleLocationsInfoEXT.Buffer malloc(int capacity) Returns a new `VkSampleLocationsInfoEXT.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkSampleLocationsInfoEXT.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static VkSampleLocationsInfoEXT malloc(MemoryStack stack) Returns a new `VkSampleLocationsInfoEXT` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkSampleLocationsInfoEXT malloc(MemoryStack stack)

Returns a new VkSampleLocationsInfoEXT instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static VkSampleLocationsInfoEXT.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkSampleLocationsInfoEXT.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static VkSampleLocationsInfoEXT.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

mallocStack back to summary

mallocStack	back to summary
public static VkSampleLocationsInfoEXT mallocStack() Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkSampleLocationsInfoEXT mallocStack()

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkSampleLocationsInfoEXT mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkSampleLocationsInfoEXT mallocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkSampleLocationsInfoEXT.Buffer mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkSampleLocationsInfoEXT.Buffer mallocStack(int capacity)

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkSampleLocationsInfoEXT.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkSampleLocationsInfoEXT.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

npNext	back to summary
public static long npNext(long struct) Unsafe version of `pNext`.

npNext	back to summary
public static void npNext(long struct, long value) Unsafe version of `pNext`.

npSampleLocations back to summary

npSampleLocations	back to summary
public static VkSampleLocationEXT.Buffer npSampleLocations(long struct) Unsafe version of `pSampleLocations`. Annotations @Nullable

public static VkSampleLocationEXT.Buffer npSampleLocations(long struct)

Unsafe version of pSampleLocations.

Annotations

@Nullable

npSampleLocations	back to summary
public static void npSampleLocations(long struct, VkSampleLocationEXT.Buffer value) Unsafe version of `pSampleLocations`.

nsampleLocationGridSize	back to summary
public static VkExtent2D nsampleLocationGridSize(long struct) Unsafe version of `sampleLocationGridSize`.

nsampleLocationGridSize	back to summary
public static void nsampleLocationGridSize(long struct, VkExtent2D value) Unsafe version of `sampleLocationGridSize`.

nsampleLocationsCount	back to summary
public static int nsampleLocationsCount(long struct) Unsafe version of `sampleLocationsCount`.

nsampleLocationsCount	back to summary
public static void nsampleLocationsCount(long struct, int value) Sets the specified value to the `sampleLocationsCount` field of the specified `struct`.

nsampleLocationsPerPixel	back to summary
public static int nsampleLocationsPerPixel(long struct) Unsafe version of `sampleLocationsPerPixel`.

nsampleLocationsPerPixel	back to summary
public static void nsampleLocationsPerPixel(long struct, int value) Unsafe version of `sampleLocationsPerPixel`.

nsType	back to summary
public static int nsType(long struct) Unsafe version of `sType`.

nsType	back to summary
public static void nsType(long struct, int value) Unsafe version of `sType`.

pNext back to summary

pNext	back to summary
public long pNext() `NULL` or a pointer to a structure extending this structure. Annotations @NativeType:void const *

public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations

@NativeType:void const *

pNext	back to summary
public VkSampleLocationsInfoEXT pNext(long value) Sets the specified value to the `pNext` field.

pSampleLocations back to summary

public VkSampleLocationEXT.Buffer pSampleLocations()

a pointer to an array of sampleLocationsCount VkSampleLocationEXT structures.

Annotations

@Nullable
@NativeType:VkSampleLocationEXT const *

pSampleLocations	back to summary
public VkSampleLocationsInfoEXT pSampleLocations(VkSampleLocationEXT.Buffer value) Sets the address of the specified `VkSampleLocationEXT.Buffer` to the `pSampleLocations` field.

sampleLocationGridSize	back to summary
public VkExtent2D sampleLocationGridSize() the size of the sample location grid to select custom sample locations for.

sampleLocationGridSize	back to summary
public VkSampleLocationsInfoEXT sampleLocationGridSize(VkExtent2D value) Copies the specified `VkExtent2D` to the `sampleLocationGridSize` field.

sampleLocationGridSize	back to summary
public VkSampleLocationsInfoEXT sampleLocationGridSize(Consumer<VkExtent2D> consumer) Passes the `sampleLocationGridSize` field to the specified `Consumer`.

sampleLocationsCount back to summary

public int sampleLocationsCount()

the number of sample locations in pSampleLocations.

Annotations

@NativeType:uint32_t

sampleLocationsPerPixel back to summary

public int sampleLocationsPerPixel()

a VkSampleCountFlagBits value specifying the number of sample locations per pixel.

Annotations

@NativeType:VkSampleCountFlagBits

sampleLocationsPerPixel	back to summary
public VkSampleLocationsInfoEXT sampleLocationsPerPixel(int value) Sets the specified value to the `sampleLocationsPerPixel` field.

set	back to summary
public VkSampleLocationsInfoEXT set(int sType, long pNext, int sampleLocationsPerPixel, VkExtent2D sampleLocationGridSize, VkSampleLocationEXT.Buffer pSampleLocations) Initializes this struct with the specified values.

set

back to summary

public VkSampleLocationsInfoEXT set(VkSampleLocationsInfoEXT src)

Copies the specified struct data to this struct.

Parameters

src:VkSampleLocationsInfoEXT: the source struct

Returns:VkSampleLocationsInfoEXT

this struct

sizeof back to summary

public int sizeof()

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

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

Returns sizeof(struct).

Annotations

@Override

sType back to summary

public int sType()

a VkStructureType value identifying this structure.

Annotations

@NativeType:VkStructureType

sType	back to summary
public VkSampleLocationsInfoEXT sType(int value) Sets the specified value to the `sType` field.

sType$Default	back to summary
public VkSampleLocationsInfoEXT sType$Default() Sets the `STRUCTURE_TYPE_SAMPLE_LOCATIONS_INFO_EXT` value to the `sType` field.

validate back 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 VkSampleLocationsInfoEXT.Buffer

Class Inheritance

extends StructBuffer<VkSampleLocationsInfoEXT, VkSampleLocationsInfoEXT.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.vulkan.VkSampleLocationsInfoEXT.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkSampleLocationsInfoEXT structs.

Field Summary

Modifier and Type	Field and Description
private static final VkSampleLocationsInfoEXT	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkSampleLocationsInfoEXT.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 Type	Method and Description
protected VkSampleLocationsInfoEXT	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `VkSampleLocationsInfoEXT#pNext` field. pNext()
public VkSampleLocationsInfoEXT.Buffer	pNext(long value) Sets the specified value to the `VkSampleLocationsInfoEXT#pNext` field.
public VkSampleLocationEXT.Buffer	Returns: a `VkSampleLocationEXT.Buffer` view of the struct array pointed to by the `VkSampleLocationsInfoEXT#pSampleLocations` field. pSampleLocations()
public VkSampleLocationsInfoEXT.Buffer	pSampleLocations(VkSampleLocationEXT.Buffer value) Sets the address of the specified `VkSampleLocationEXT.Buffer` to the `VkSampleLocationsInfoEXT#pSampleLocations` field.
public VkExtent2D	Returns: a `VkExtent2D` view of the `VkSampleLocationsInfoEXT#sampleLocationGridSize` field. sampleLocationGridSize()
public VkSampleLocationsInfoEXT.Buffer	sampleLocationGridSize(VkExtent2D value) Copies the specified `VkExtent2D` to the `VkSampleLocationsInfoEXT#sampleLocationGridSize` field.
public VkSampleLocationsInfoEXT.Buffer	sampleLocationGridSize(Consumer<VkExtent2D> consumer) Passes the `VkSampleLocationsInfoEXT#sampleLocationGridSize` field to the specified `Consumer`.
public int	Returns: the value of the `VkSampleLocationsInfoEXT#sampleLocationsCount` field. sampleLocationsCount()
public int	Returns: the value of the `VkSampleLocationsInfoEXT#sampleLocationsPerPixel` field. sampleLocationsPerPixel()
public VkSampleLocationsInfoEXT.Buffer	sampleLocationsPerPixel(int value) Sets the specified value to the `VkSampleLocationsInfoEXT#sampleLocationsPerPixel` field.
protected VkSampleLocationsInfoEXT.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `VkSampleLocationsInfoEXT#sType` field. sType()
public VkSampleLocationsInfoEXT.Buffer	sType(int value) Sets the specified value to the `VkSampleLocationsInfoEXT#sType` field.
public VkSampleLocationsInfoEXT.Buffer	sType$Default() Sets the `STRUCTURE_TYPE_SAMPLE_LOCATIONS_INFO_EXT` value to the `VkSampleLocationsInfoEXT#sType` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final VkSampleLocationsInfoEXT ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new VkSampleLocationsInfoEXT.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 VkSampleLocationsInfoEXT#SIZEOF, and its mark will be undefined.

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

Buffer	back to summary
public Buffer(long address, int cap)

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

Method Detail

getElementFactory

back to summary

protected VkSampleLocationsInfoEXT getElementFactory()

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

Annotations

@Override

pNext	back to summary
public long pNext() Returns:long the value of the `VkSampleLocationsInfoEXT#pNext` field. Annotations @NativeType:void const *

pNext	back to summary
public VkSampleLocationsInfoEXT.Buffer pNext(long value) Sets the specified value to the `VkSampleLocationsInfoEXT#pNext` field.

pSampleLocations	back to summary
public VkSampleLocationEXT.Buffer pSampleLocations() Returns:VkSampleLocationEXT.Buffer a `VkSampleLocationEXT.Buffer` view of the struct array pointed to by the `VkSampleLocationsInfoEXT#pSampleLocations` field. Annotations @Nullable @NativeType:VkSampleLocationEXT const *

pSampleLocations	back to summary
public VkSampleLocationsInfoEXT.Buffer pSampleLocations(VkSampleLocationEXT.Buffer value) Sets the address of the specified `VkSampleLocationEXT.Buffer` to the `VkSampleLocationsInfoEXT#pSampleLocations` field.

sampleLocationGridSize	back to summary
public VkExtent2D sampleLocationGridSize() Returns:VkExtent2D a `VkExtent2D` view of the `VkSampleLocationsInfoEXT#sampleLocationGridSize` field.

sampleLocationGridSize	back to summary
public VkSampleLocationsInfoEXT.Buffer sampleLocationGridSize(VkExtent2D value) Copies the specified `VkExtent2D` to the `VkSampleLocationsInfoEXT#sampleLocationGridSize` field.

sampleLocationGridSize	back to summary
public VkSampleLocationsInfoEXT.Buffer sampleLocationGridSize(Consumer<VkExtent2D> consumer) Passes the `VkSampleLocationsInfoEXT#sampleLocationGridSize` field to the specified `Consumer`.

sampleLocationsCount	back to summary
public int sampleLocationsCount() Returns:int the value of the `VkSampleLocationsInfoEXT#sampleLocationsCount` field. Annotations @NativeType:uint32_t

sampleLocationsPerPixel	back to summary
public int sampleLocationsPerPixel() Returns:int the value of the `VkSampleLocationsInfoEXT#sampleLocationsPerPixel` field. Annotations @NativeType:VkSampleCountFlagBits

sampleLocationsPerPixel	back to summary
public VkSampleLocationsInfoEXT.Buffer sampleLocationsPerPixel(int value) Sets the specified value to the `VkSampleLocationsInfoEXT#sampleLocationsPerPixel` field.

self

back to summary

protected VkSampleLocationsInfoEXT.Buffer self()

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

Annotations

@Override

sType	back to summary
public int sType() Returns:int the value of the `VkSampleLocationsInfoEXT#sType` field. Annotations @NativeType:VkStructureType

sType	back to summary
public VkSampleLocationsInfoEXT.Buffer sType(int value) Sets the specified value to the `VkSampleLocationsInfoEXT#sType` field.

sType$Default	back to summary
public VkSampleLocationsInfoEXT.Buffer sType$Default() Sets the `STRUCTURE_TYPE_SAMPLE_LOCATIONS_INFO_EXT` value to the `VkSampleLocationsInfoEXT#sType` field.

public Class VkSampleLocationsInfoEXT

Description

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class VkSampleLocationsInfoEXT.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail