Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkSampleLocationEXT

extends Struct<VkSampleLocationEXT>
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 coordinates of a sample location.
Description

The domain space of the sample location coordinates has an upper-left origin within the pixel in framebuffer space.

The values specified in a VkSampleLocationEXT structure are always clamped to the implementation-dependent sample location coordinate range [sampleLocationCoordinateRange[0],sampleLocationCoordinateRange[1]] that can be queried using VkPhysicalDeviceSampleLocationsPropertiesEXT.

See Also

VkSampleLocationsInfoEXT

Layout


struct VkSampleLocationEXT {
    float x;
    float y;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkSampleLocationEXT.Buffer

An array of VkSampleLocationEXT structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
SIZEOF

The struct size in bytes.

public static final int
X

The struct member offsets.

public static final int
Y

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkSampleLocationEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkSampleLocationEXT
calloc()

Returns a new VkSampleLocationEXT instance allocated with memCalloc.

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

Returns a new VkSampleLocationEXT.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkSampleLocationEXT
callocStack()

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

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

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

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

Returns a new VkSampleLocationEXT instance allocated with BufferUtils.

public static VkSampleLocationEXT
create(long address)

Returns a new VkSampleLocationEXT instance for the specified memory address.

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

Returns a new VkSampleLocationEXT.Buffer instance allocated with BufferUtils.

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

Create a VkSampleLocationEXT.Buffer instance at the specified memory.

public static VkSampleLocationEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkSampleLocationEXT
malloc()

Returns a new VkSampleLocationEXT instance allocated with memAlloc.

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

Returns a new VkSampleLocationEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkSampleLocationEXT instance allocated on the specified MemoryStack.

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

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

public static VkSampleLocationEXT
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static float
nx(long struct)

Unsafe version of x.

public static void
nx(long struct, float value)

Unsafe version of x.

public static float
ny(long struct)

Unsafe version of y.

public static void
ny(long struct, float value)

Unsafe version of y.

public VkSampleLocationEXT
set(float x, float y)

Initializes this struct with the specified values.

public VkSampleLocationEXT

Returns:

this struct
set(VkSampleLocationEXT
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 float
x()

the horizontal coordinate of the sample’s location.

public VkSampleLocationEXT
x(float value)

Sets the specified value to the x field.

public float
y()

the vertical coordinate of the sample’s location.

public VkSampleLocationEXT
y(float value)

Sets the specified value to the y field.

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.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Xback to summary
public static final int X

The struct member offsets.

Yback to summary
public static final int Y

The struct member offsets.

Constructor Detail

VkSampleLocationEXTback to summary
protected VkSampleLocationEXT(long address, ByteBuffer container)
VkSampleLocationEXTback to summary
public VkSampleLocationEXT(ByteBuffer container)

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

callocback to summary
public static VkSampleLocationEXT calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkSampleLocationEXT calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new VkSampleLocationEXT instance allocated with BufferUtils.

createback to summary
public static VkSampleLocationEXT create(long address)

Returns a new VkSampleLocationEXT instance for the specified memory address.

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

Returns a new VkSampleLocationEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkSampleLocationEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkSampleLocationEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkSampleLocationEXT malloc(MemoryStack stack)

Returns a new VkSampleLocationEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nxback to summary
public static float nx(long struct)

Unsafe version of x.

nxback to summary
public static void nx(long struct, float value)

Unsafe version of x.

nyback to summary
public static float ny(long struct)

Unsafe version of y.

nyback to summary
public static void ny(long struct, float value)

Unsafe version of y.

setback to summary
public VkSampleLocationEXT set(float x, float y)

Initializes this struct with the specified values.

setback to summary
public VkSampleLocationEXT set(VkSampleLocationEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkSampleLocationEXT

the source struct

Returns:VkSampleLocationEXT

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
xback to summary
public float x()

the horizontal coordinate of the sample’s location.

xback to summary
public VkSampleLocationEXT x(float value)

Sets the specified value to the x field.

yback to summary
public float y()

the vertical coordinate of the sample’s location.

yback to summary
public VkSampleLocationEXT y(float value)

Sets the specified value to the y field.

org.lwjgl.vulkan back to summary

public Class VkSampleLocationEXT.Buffer

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

Field Summary

Modifier and TypeField and Description
private static final VkSampleLocationEXT
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkSampleLocationEXT.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
protected VkSampleLocationEXT
getElementFactory()

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

protected VkSampleLocationEXT.Buffer
self()

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

public float

Returns:

the value of the VkSampleLocationEXT#x field.
x()

public VkSampleLocationEXT.Buffer
x(float value)

Sets the specified value to the VkSampleLocationEXT#x field.

public float

Returns:

the value of the VkSampleLocationEXT#y field.
y()

public VkSampleLocationEXT.Buffer
y(float value)

Sets the specified value to the VkSampleLocationEXT#y field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkSampleLocationEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

getElementFactoryback to summary
protected VkSampleLocationEXT getElementFactory()

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

Annotations
@Override
selfback to summary
protected VkSampleLocationEXT.Buffer self()

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

Annotations
@Override
xback to summary
public float x()
Returns:float

the value of the VkSampleLocationEXT#x field.

xback to summary
public VkSampleLocationEXT.Buffer x(float value)

Sets the specified value to the VkSampleLocationEXT#x field.

yback to summary
public float y()
Returns:float

the value of the VkSampleLocationEXT#y field.

yback to summary
public VkSampleLocationEXT.Buffer y(float value)

Sets the specified value to the VkSampleLocationEXT#y field.