Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkOffset3D

extends Struct<VkOffset3D>
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 a three-dimensional offset.
See Also

VkBufferImageCopy, VkBufferImageCopy2, VkCopyMemoryToImageIndirectCommandNV, VkImageBlit, VkImageBlit2, VkImageCopy, VkImageCopy2, VkImageResolve, VkImageResolve2, VkImageToMemoryCopyEXT, VkMemoryToImageCopyEXT, VkSparseImageMemoryBind

Layout


struct VkOffset3D {
    int32_t x;
    int32_t y;
    int32_t z;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkOffset3D.Buffer

An array of VkOffset3D 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.

public static final int
Z

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkOffset3D(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkOffset3D
calloc()

Returns a new VkOffset3D instance allocated with memCalloc.

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

Returns a new VkOffset3D.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkOffset3D
callocStack()

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

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

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

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

Returns a new VkOffset3D instance allocated with BufferUtils.

public static VkOffset3D
create(long address)

Returns a new VkOffset3D instance for the specified memory address.

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

Returns a new VkOffset3D.Buffer instance allocated with BufferUtils.

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

Create a VkOffset3D.Buffer instance at the specified memory.

public static VkOffset3D
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkOffset3D
malloc()

Returns a new VkOffset3D instance allocated with memAlloc.

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

Returns a new VkOffset3D.Buffer instance allocated with memAlloc.

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

Returns a new VkOffset3D instance allocated on the specified MemoryStack.

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

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

public static VkOffset3D
mallocStack()

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

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

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

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

Unsafe version of x.

public static void
nx(long struct, int value)

Unsafe version of x.

public static int
ny(long struct)

Unsafe version of y.

public static void
ny(long struct, int value)

Unsafe version of y.

public static int
nz(long struct)

Unsafe version of z.

public static void
nz(long struct, int value)

Unsafe version of z.

public VkOffset3D
set(int x, int y, int z)

Initializes this struct with the specified values.

public VkOffset3D

Returns:

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

the x offset.

public VkOffset3D
x(int value)

Sets the specified value to the x field.

public int
y()

the y offset.

public VkOffset3D
y(int value)

Sets the specified value to the y field.

public int
z()

the z offset.

public VkOffset3D
z(int value)

Sets the specified value to the z 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.

Zback to summary
public static final int Z

The struct member offsets.

Constructor Detail

VkOffset3Dback to summary
protected VkOffset3D(long address, ByteBuffer container)
VkOffset3Dback to summary
public VkOffset3D(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkOffset3D calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new VkOffset3D instance allocated with BufferUtils.

createback to summary
public static VkOffset3D create(long address)

Returns a new VkOffset3D instance for the specified memory address.

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

Returns a new VkOffset3D.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkOffset3D.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkOffset3D createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkOffset3D malloc(MemoryStack stack)

Returns a new VkOffset3D instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkOffset3D.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 int nx(long struct)

Unsafe version of x.

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

Unsafe version of x.

nyback to summary
public static int ny(long struct)

Unsafe version of y.

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

Unsafe version of y.

nzback to summary
public static int nz(long struct)

Unsafe version of z.

nzback to summary
public static void nz(long struct, int value)

Unsafe version of z.

setback to summary
public VkOffset3D set(int x, int y, int z)

Initializes this struct with the specified values.

setback to summary
public VkOffset3D set(VkOffset3D src)

Copies the specified struct data to this struct.

Parameters
src:VkOffset3D

the source struct

Returns:VkOffset3D

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 int x()

the x offset.

Annotations
@NativeType:int32_t
xback to summary
public VkOffset3D x(int value)

Sets the specified value to the x field.

yback to summary
public int y()

the y offset.

Annotations
@NativeType:int32_t
yback to summary
public VkOffset3D y(int value)

Sets the specified value to the y field.

zback to summary
public int z()

the z offset.

Annotations
@NativeType:int32_t
zback to summary
public VkOffset3D z(int value)

Sets the specified value to the z field.

org.lwjgl.vulkan back to summary

public Class VkOffset3D.Buffer

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

Field Summary

Modifier and TypeField and Description
private static final VkOffset3D
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

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

protected VkOffset3D.Buffer
self()

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

public int

Returns:

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

public VkOffset3D.Buffer
x(int value)

Sets the specified value to the VkOffset3D#x field.

public int

Returns:

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

public VkOffset3D.Buffer
y(int value)

Sets the specified value to the VkOffset3D#y field.

public int

Returns:

the value of the VkOffset3D#z field.
z()

public VkOffset3D.Buffer
z(int value)

Sets the specified value to the VkOffset3D#z field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkOffset3D ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

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

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

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

the value of the VkOffset3D#x field.

Annotations
@NativeType:int32_t
xback to summary
public VkOffset3D.Buffer x(int value)

Sets the specified value to the VkOffset3D#x field.

yback to summary
public int y()
Returns:int

the value of the VkOffset3D#y field.

Annotations
@NativeType:int32_t
yback to summary
public VkOffset3D.Buffer y(int value)

Sets the specified value to the VkOffset3D#y field.

zback to summary
public int z()
Returns:int

the value of the VkOffset3D#z field.

Annotations
@NativeType:int32_t
zback to summary
public VkOffset3D.Buffer z(int value)

Sets the specified value to the VkOffset3D#z field.