Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkCoarseSampleLocationNV

extends Struct<VkCoarseSampleLocationNV>
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 parameters controlling shading rate image usage.
Valid Usage
See Also

VkCoarseSampleOrderCustomNV

Layout


struct VkCoarseSampleLocationNV {
    uint32_t pixelX;
    uint32_t pixelY;
    uint32_t sample;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
PIXELX

The struct member offsets.

public static final int
PIXELY

The struct member offsets.

public static final int
SAMPLE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkCoarseSampleLocationNV(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkCoarseSampleLocationNV
calloc()

Returns a new VkCoarseSampleLocationNV instance allocated with memCalloc.

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

Returns a new VkCoarseSampleLocationNV.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkCoarseSampleLocationNV
callocStack()

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

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

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

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

Returns a new VkCoarseSampleLocationNV instance allocated with BufferUtils.

public static VkCoarseSampleLocationNV
create(long address)

Returns a new VkCoarseSampleLocationNV instance for the specified memory address.

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

Returns a new VkCoarseSampleLocationNV.Buffer instance allocated with BufferUtils.

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

Create a VkCoarseSampleLocationNV.Buffer instance at the specified memory.

public static VkCoarseSampleLocationNV
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkCoarseSampleLocationNV
malloc()

Returns a new VkCoarseSampleLocationNV instance allocated with memAlloc.

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

Returns a new VkCoarseSampleLocationNV.Buffer instance allocated with memAlloc.

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

Returns a new VkCoarseSampleLocationNV instance allocated on the specified MemoryStack.

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

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

public static VkCoarseSampleLocationNV
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static int
npixelX(long struct)

Unsafe version of pixelX.

public static void
npixelX(long struct, int value)

Unsafe version of pixelX.

public static int
npixelY(long struct)

Unsafe version of pixelY.

public static void
npixelY(long struct, int value)

Unsafe version of pixelY.

public static int
nsample(long struct)

Unsafe version of sample.

public static void
nsample(long struct, int value)

Unsafe version of sample.

public int
pixelX()

added to the x coordinate of the upper-leftmost pixel of each fragment to identify the pixel containing the coverage sample.

public VkCoarseSampleLocationNV
pixelX(int value)

Sets the specified value to the pixelX field.

public int
pixelY()

added to the y coordinate of the upper-leftmost pixel of each fragment to identify the pixel containing the coverage sample.

public VkCoarseSampleLocationNV
pixelY(int value)

Sets the specified value to the pixelY field.

public int
sample()

the number of the coverage sample in the pixel identified by pixelX and pixelY.

public VkCoarseSampleLocationNV
sample(int value)

Sets the specified value to the sample field.

public VkCoarseSampleLocationNV
set(int pixelX, int pixelY, int sample)

Initializes this struct with the specified values.

public VkCoarseSampleLocationNV

Returns:

this struct
set
(VkCoarseSampleLocationNV
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).
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.

PIXELXback to summary
public static final int PIXELX

The struct member offsets.

PIXELYback to summary
public static final int PIXELY

The struct member offsets.

SAMPLEback to summary
public static final int SAMPLE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

VkCoarseSampleLocationNVback to summary
protected VkCoarseSampleLocationNV(long address, ByteBuffer container)
VkCoarseSampleLocationNVback to summary
public VkCoarseSampleLocationNV(ByteBuffer container)

Creates a VkCoarseSampleLocationNV 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 VkCoarseSampleLocationNV calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkCoarseSampleLocationNV calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new VkCoarseSampleLocationNV instance allocated with BufferUtils.

createback to summary
public static VkCoarseSampleLocationNV create(long address)

Returns a new VkCoarseSampleLocationNV instance for the specified memory address.

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

Returns a new VkCoarseSampleLocationNV.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkCoarseSampleLocationNV.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkCoarseSampleLocationNV createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkCoarseSampleLocationNV malloc(MemoryStack stack)

Returns a new VkCoarseSampleLocationNV instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
npixelXback to summary
public static int npixelX(long struct)

Unsafe version of pixelX.

npixelXback to summary
public static void npixelX(long struct, int value)

Unsafe version of pixelX.

npixelYback to summary
public static int npixelY(long struct)

Unsafe version of pixelY.

npixelYback to summary
public static void npixelY(long struct, int value)

Unsafe version of pixelY.

nsampleback to summary
public static int nsample(long struct)

Unsafe version of sample.

nsampleback to summary
public static void nsample(long struct, int value)

Unsafe version of sample.

pixelXback to summary
public int pixelX()

added to the x coordinate of the upper-leftmost pixel of each fragment to identify the pixel containing the coverage sample.

Annotations
@NativeType:uint32_t
pixelXback to summary
public VkCoarseSampleLocationNV pixelX(int value)

Sets the specified value to the pixelX field.

pixelYback to summary
public int pixelY()

added to the y coordinate of the upper-leftmost pixel of each fragment to identify the pixel containing the coverage sample.

Annotations
@NativeType:uint32_t
pixelYback to summary
public VkCoarseSampleLocationNV pixelY(int value)

Sets the specified value to the pixelY field.

sampleback to summary
public int sample()

the number of the coverage sample in the pixel identified by pixelX and pixelY.

Annotations
@NativeType:uint32_t
sampleback to summary
public VkCoarseSampleLocationNV sample(int value)

Sets the specified value to the sample field.

setback to summary
public VkCoarseSampleLocationNV set(int pixelX, int pixelY, int sample)

Initializes this struct with the specified values.

setback to summary
public VkCoarseSampleLocationNV set(VkCoarseSampleLocationNV src)

Copies the specified struct data to this struct.

Parameters
src:VkCoarseSampleLocationNV

the source struct

Returns:VkCoarseSampleLocationNV

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
org.lwjgl.vulkan back to summary

public Class VkCoarseSampleLocationNV.Buffer

extends StructBuffer<VkCoarseSampleLocationNV, VkCoarseSampleLocationNV.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkCoarseSampleLocationNV structs.

Field Summary

Modifier and TypeField and Description
private static final VkCoarseSampleLocationNV

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkCoarseSampleLocationNV.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 VkCoarseSampleLocationNV
public int

Returns:

the value of the VkCoarseSampleLocationNV#pixelX field.
pixelX
()

public VkCoarseSampleLocationNV.Buffer
pixelX(int value)

Sets the specified value to the VkCoarseSampleLocationNV#pixelX field.

public int

Returns:

the value of the VkCoarseSampleLocationNV#pixelY field.
pixelY
()

public VkCoarseSampleLocationNV.Buffer
pixelY(int value)

Sets the specified value to the VkCoarseSampleLocationNV#pixelY field.

public int

Returns:

the value of the VkCoarseSampleLocationNV#sample field.
sample
()

public VkCoarseSampleLocationNV.Buffer
sample(int value)

Sets the specified value to the VkCoarseSampleLocationNV#sample field.

protected VkCoarseSampleLocationNV.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkCoarseSampleLocationNV ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkCoarseSampleLocationNV.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 VkCoarseSampleLocationNV#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 VkCoarseSampleLocationNV getElementFactory()

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

Annotations
@Override
pixelXback to summary
public int pixelX()
Returns:int

the value of the VkCoarseSampleLocationNV#pixelX field.

Annotations
@NativeType:uint32_t
pixelXback to summary
public VkCoarseSampleLocationNV.Buffer pixelX(int value)

Sets the specified value to the VkCoarseSampleLocationNV#pixelX field.

pixelYback to summary
public int pixelY()
Returns:int

the value of the VkCoarseSampleLocationNV#pixelY field.

Annotations
@NativeType:uint32_t
pixelYback to summary
public VkCoarseSampleLocationNV.Buffer pixelY(int value)

Sets the specified value to the VkCoarseSampleLocationNV#pixelY field.

sampleback to summary
public int sample()
Returns:int

the value of the VkCoarseSampleLocationNV#sample field.

Annotations
@NativeType:uint32_t
sampleback to summary
public VkCoarseSampleLocationNV.Buffer sample(int value)

Sets the specified value to the VkCoarseSampleLocationNV#sample field.

selfback to summary
protected VkCoarseSampleLocationNV.Buffer self()

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

Annotations
@Override