Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkTransformMatrixKHR

extends Struct<VkTransformMatrixKHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkTransformMatrixNV
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying a 3x4 affine transformation matrix.
Valid Usage
See Also

VkAccelerationStructureInstanceKHR, VkAccelerationStructureMatrixMotionInstanceNV

Layout


struct VkTransformMatrixKHR {
    float matrix[3][4];
}

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
MATRIX

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
VkTransformMatrixKHR(long address, ByteBuffer container)

public
VkTransformMatrixKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkTransformMatrixKHR
calloc()

Returns a new VkTransformMatrixKHR instance allocated with memCalloc.

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

Returns a new VkTransformMatrixKHR.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkTransformMatrixKHR
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 VkTransformMatrixKHR
create()

Returns a new VkTransformMatrixKHR instance allocated with BufferUtils.

public static VkTransformMatrixKHR
create(long address)

Returns a new VkTransformMatrixKHR instance for the specified memory address.

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

Returns a new VkTransformMatrixKHR.Buffer instance allocated with BufferUtils.

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

Create a VkTransformMatrixKHR.Buffer instance at the specified memory.

public static VkTransformMatrixKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkTransformMatrixKHR
malloc()

Returns a new VkTransformMatrixKHR instance allocated with memAlloc.

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

Returns a new VkTransformMatrixKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkTransformMatrixKHR instance allocated on the specified MemoryStack.

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

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

public FloatBuffer
matrix()

a 3x4 row-major affine transformation matrix.

public float
matrix(int index)

a 3x4 row-major affine transformation matrix.

public VkTransformMatrixKHR
matrix(FloatBuffer value)

Copies the specified FloatBuffer to the matrix field.

public VkTransformMatrixKHR
matrix(int index, float value)

Sets the specified value at the specified index of the matrix field.

public static FloatBuffer
nmatrix(long struct)

Unsafe version of matrix.

public static float
nmatrix(long struct, int index)

Unsafe version of matrix.

public static void
nmatrix(long struct, FloatBuffer value)

Unsafe version of matrix.

public static void
nmatrix(long struct, int index, float value)

Unsafe version of matrix.

public VkTransformMatrixKHR

Returns:

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

MATRIXback to summary
public static final int MATRIX

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

VkTransformMatrixKHRback to summary
protected VkTransformMatrixKHR(long address, ByteBuffer container)
VkTransformMatrixKHRback to summary
public VkTransformMatrixKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkTransformMatrixKHR calloc(MemoryStack stack)

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

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

createback to summary
protected VkTransformMatrixKHR 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 VkTransformMatrixKHR create()

Returns a new VkTransformMatrixKHR instance allocated with BufferUtils.

createback to summary
public static VkTransformMatrixKHR create(long address)

Returns a new VkTransformMatrixKHR instance for the specified memory address.

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

Returns a new VkTransformMatrixKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkTransformMatrixKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkTransformMatrixKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkTransformMatrixKHR malloc(MemoryStack stack)

Returns a new VkTransformMatrixKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

matrixback to summary
public FloatBuffer matrix()

a 3x4 row-major affine transformation matrix.

Annotations
@NativeType:float[3][4]
matrixback to summary
public float matrix(int index)

a 3x4 row-major affine transformation matrix.

matrixback to summary
public VkTransformMatrixKHR matrix(FloatBuffer value)

Copies the specified FloatBuffer to the matrix field.

matrixback to summary
public VkTransformMatrixKHR matrix(int index, float value)

Sets the specified value at the specified index of the matrix field.

nmatrixback to summary
public static FloatBuffer nmatrix(long struct)

Unsafe version of matrix.

nmatrixback to summary
public static float nmatrix(long struct, int index)

Unsafe version of matrix.

nmatrixback to summary
public static void nmatrix(long struct, FloatBuffer value)

Unsafe version of matrix.

nmatrixback to summary
public static void nmatrix(long struct, int index, float value)

Unsafe version of matrix.

setback to summary
public VkTransformMatrixKHR set(VkTransformMatrixKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkTransformMatrixKHR

the source struct

Returns:VkTransformMatrixKHR

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 VkTransformMatrixKHR.Buffer

extends StructBuffer<VkTransformMatrixKHR, VkTransformMatrixKHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkTransformMatrixNV.Buffer

An array of VkTransformMatrixKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkTransformMatrixKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkTransformMatrixKHR.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 VkTransformMatrixKHR
public FloatBuffer

Returns:

a FloatBuffer view of the VkTransformMatrixKHR#matrix field.
matrix
()

public float

Returns:

the value at the specified index of the VkTransformMatrixKHR#matrix field.
matrix
(int index)

public VkTransformMatrixKHR.Buffer
matrix(FloatBuffer value)

Copies the specified FloatBuffer to the VkTransformMatrixKHR#matrix field.

public VkTransformMatrixKHR.Buffer
matrix(int index, float value)

Sets the specified value at the specified index of the VkTransformMatrixKHR#matrix field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkTransformMatrixKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
matrixback to summary
public FloatBuffer matrix()
Returns:FloatBuffer

a FloatBuffer view of the VkTransformMatrixKHR#matrix field.

Annotations
@NativeType:float[3][4]
matrixback to summary
public float matrix(int index)
Returns:float

the value at the specified index of the VkTransformMatrixKHR#matrix field.

matrixback to summary
public VkTransformMatrixKHR.Buffer matrix(FloatBuffer value)

Copies the specified FloatBuffer to the VkTransformMatrixKHR#matrix field.

matrixback to summary
public VkTransformMatrixKHR.Buffer matrix(int index, float value)

Sets the specified value at the specified index of the VkTransformMatrixKHR#matrix field.

selfback to summary
protected VkTransformMatrixKHR.Buffer self()

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

Annotations
@Override