Package org.lwjgl.vulkan

Class VkBufferImageCopy

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkBufferImageCopy>

org.lwjgl.vulkan.VkBufferImageCopy

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkBufferImageCopy
extends Struct<VkBufferImageCopy>
implements NativeResource

Structure specifying a buffer image copy operation.

Valid Usage

• bufferRowLength must be 0, or greater than or equal to the width member of imageExtent
• bufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
• The aspectMask member of imageSubresource must only have a single bit set
• imageExtent.width must not be 0
• imageExtent.height must not be 0
• imageExtent.depth must not be 0

Valid Usage (Implicit)

• imageSubresource must be a valid VkImageSubresourceLayers structure

See Also

VkExtent3D, VkImageSubresourceLayers, VkOffset3D, CmdCopyBufferToImage, CmdCopyImageToBuffer

Layout

 struct VkBufferImageCopy {
     VkDeviceSize bufferOffset();
     uint32_t bufferRowLength();
     uint32_t bufferImageHeight();
     VkImageSubresourceLayers imageSubresource();
     VkOffset3D imageOffset();
     VkExtent3D imageExtent();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkBufferImageCopy.Buffer	An array of VkBufferImageCopy structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	BUFFERIMAGEHEIGHT	The struct member offsets.
static final int	BUFFEROFFSET	The struct member offsets.
static final int	BUFFERROWLENGTH	The struct member offsets.
static final int	IMAGEEXTENT	The struct member offsets.
static final int	IMAGEOFFSET	The struct member offsets.
static final int	IMAGESUBRESOURCE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkBufferImageCopy(ByteBuffer container)	Creates a VkBufferImageCopy instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
int	bufferImageHeight()	see bufferRowLength
VkBufferImageCopy	bufferImageHeight(int value)	Sets the specified value to the bufferImageHeight() field.
long	bufferOffset()	the offset in bytes from the start of the buffer object where the image data is copied from or to.
VkBufferImageCopy	bufferOffset(long value)	Sets the specified value to the bufferOffset() field.
int	bufferRowLength()	bufferRowLength and bufferImageHeight specify in texels a subregion of a larger two- or three-dimensional image in buffer memory, and control the addressing calculations.
VkBufferImageCopy	bufferRowLength(int value)	Sets the specified value to the bufferRowLength() field.
static VkBufferImageCopy	calloc()	Returns a new VkBufferImageCopy instance allocated with memCalloc.
static VkBufferImageCopy.Buffer	calloc(int capacity)	Returns a new VkBufferImageCopy.Buffer instance allocated with memCalloc.
static VkBufferImageCopy.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkBufferImageCopy.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkBufferImageCopy	calloc(MemoryStack stack)	Returns a new VkBufferImageCopy instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkBufferImageCopy	callocStack()	Deprecated.
static VkBufferImageCopy.Buffer	callocStack(int capacity)	Deprecated.
static VkBufferImageCopy.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkBufferImageCopy	callocStack(MemoryStack stack)	Deprecated.
static VkBufferImageCopy	create()	Returns a new VkBufferImageCopy instance allocated with BufferUtils.
static VkBufferImageCopy.Buffer	create(int capacity)	Returns a new VkBufferImageCopy.Buffer instance allocated with BufferUtils.
static VkBufferImageCopy	create(long address)	Returns a new VkBufferImageCopy instance for the specified memory address.
static VkBufferImageCopy.Buffer	create(long address, int capacity)	Create a VkBufferImageCopy.Buffer instance at the specified memory.
static VkBufferImageCopy	createSafe(long address)	Like create, but returns null if address is NULL.
static VkBufferImageCopy.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkExtent3D	imageExtent()	the size in texels of the image to copy in width, height and depth.
VkBufferImageCopy	imageExtent(Consumer<VkExtent3D> consumer)	Passes the imageExtent() field to the specified Consumer.
VkBufferImageCopy	imageExtent(VkExtent3D value)	Copies the specified VkExtent3D to the imageExtent() field.
VkOffset3D	imageOffset()	selects the initial x, y, z offsets in texels of the sub-region of the source or destination image data.
VkBufferImageCopy	imageOffset(Consumer<VkOffset3D> consumer)	Passes the imageOffset() field to the specified Consumer.
VkBufferImageCopy	imageOffset(VkOffset3D value)	Copies the specified VkOffset3D to the imageOffset() field.
VkImageSubresourceLayers	imageSubresource()	a VkImageSubresourceLayers used to specify the specific image subresources of the image used for the source or destination image data.
VkBufferImageCopy	imageSubresource(Consumer<VkImageSubresourceLayers> consumer)	Passes the imageSubresource() field to the specified Consumer.
VkBufferImageCopy	imageSubresource(VkImageSubresourceLayers value)	Copies the specified VkImageSubresourceLayers to the imageSubresource() field.
static VkBufferImageCopy	malloc()	Returns a new VkBufferImageCopy instance allocated with memAlloc.
static VkBufferImageCopy.Buffer	malloc(int capacity)	Returns a new VkBufferImageCopy.Buffer instance allocated with memAlloc.
static VkBufferImageCopy.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkBufferImageCopy.Buffer instance allocated on the specified MemoryStack.
static VkBufferImageCopy	malloc(MemoryStack stack)	Returns a new VkBufferImageCopy instance allocated on the specified MemoryStack.
static VkBufferImageCopy	mallocStack()	Deprecated.
static VkBufferImageCopy.Buffer	mallocStack(int capacity)	Deprecated.
static VkBufferImageCopy.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkBufferImageCopy	mallocStack(MemoryStack stack)	Deprecated.
static int	nbufferImageHeight(long struct)	Unsafe version of bufferImageHeight().
static void	nbufferImageHeight(long struct, int value)	Unsafe version of bufferImageHeight.
static long	nbufferOffset(long struct)	Unsafe version of bufferOffset().
static void	nbufferOffset(long struct, long value)	Unsafe version of bufferOffset.
static int	nbufferRowLength(long struct)	Unsafe version of bufferRowLength().
static void	nbufferRowLength(long struct, int value)	Unsafe version of bufferRowLength.
static VkExtent3D	nimageExtent(long struct)	Unsafe version of imageExtent().
static void	nimageExtent(long struct, VkExtent3D value)	Unsafe version of imageExtent.
static VkOffset3D	nimageOffset(long struct)	Unsafe version of imageOffset().
static void	nimageOffset(long struct, VkOffset3D value)	Unsafe version of imageOffset.
static VkImageSubresourceLayers	nimageSubresource(long struct)	Unsafe version of imageSubresource().
static void	nimageSubresource(long struct, VkImageSubresourceLayers value)	Unsafe version of imageSubresource.
VkBufferImageCopy	set(long bufferOffset, int bufferRowLength, int bufferImageHeight, VkImageSubresourceLayers imageSubresource, VkOffset3D imageOffset, VkExtent3D imageExtent)	Initializes this struct with the specified values.
VkBufferImageCopy	set(VkBufferImageCopy src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

BUFFEROFFSET

public static final int BUFFEROFFSET

The struct member offsets.

BUFFERROWLENGTH

public static final int BUFFERROWLENGTH

The struct member offsets.

BUFFERIMAGEHEIGHT

public static final int BUFFERIMAGEHEIGHT

The struct member offsets.

IMAGESUBRESOURCE

public static final int IMAGESUBRESOURCE

The struct member offsets.

IMAGEOFFSET

public static final int IMAGEOFFSET

The struct member offsets.

IMAGEEXTENT

public static final int IMAGEEXTENT

The struct member offsets.

Constructor Details

VkBufferImageCopy

public VkBufferImageCopy(ByteBuffer container)

Creates a VkBufferImageCopy 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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkBufferImageCopy>

bufferOffset

public long bufferOffset()

the offset in bytes from the start of the buffer object where the image data is copied from or to.

bufferRowLength

public int bufferRowLength()

bufferRowLength and bufferImageHeight specify in texels a subregion of a larger two- or three-dimensional image in buffer memory, and control the addressing calculations. If either of these values is zero, that aspect of the buffer memory is considered to be tightly packed according to the imageExtent.

bufferImageHeight

public int bufferImageHeight()

see bufferRowLength

imageSubresource

public VkImageSubresourceLayers imageSubresource()

a VkImageSubresourceLayers used to specify the specific image subresources of the image used for the source or destination image data.

imageOffset

public VkOffset3D imageOffset()

selects the initial x, y, z offsets in texels of the sub-region of the source or destination image data.

imageExtent

public VkExtent3D imageExtent()

the size in texels of the image to copy in width, height and depth.

bufferOffset

public VkBufferImageCopy bufferOffset(long value)

Sets the specified value to the bufferOffset() field.

bufferRowLength

public VkBufferImageCopy bufferRowLength(int value)

Sets the specified value to the bufferRowLength() field.

bufferImageHeight

public VkBufferImageCopy bufferImageHeight(int value)

Sets the specified value to the bufferImageHeight() field.

imageSubresource

public VkBufferImageCopy imageSubresource(VkImageSubresourceLayers value)

Copies the specified VkImageSubresourceLayers to the imageSubresource() field.

imageSubresource

public VkBufferImageCopy imageSubresource(Consumer<VkImageSubresourceLayers> consumer)

Passes the imageSubresource() field to the specified Consumer.

imageOffset

public VkBufferImageCopy imageOffset(VkOffset3D value)

Copies the specified VkOffset3D to the imageOffset() field.

imageOffset

public VkBufferImageCopy imageOffset(Consumer<VkOffset3D> consumer)

Passes the imageOffset() field to the specified Consumer.

imageExtent

public VkBufferImageCopy imageExtent(VkExtent3D value)

Copies the specified VkExtent3D to the imageExtent() field.

imageExtent

public VkBufferImageCopy imageExtent(Consumer<VkExtent3D> consumer)

Passes the imageExtent() field to the specified Consumer.

set

public VkBufferImageCopy set(long bufferOffset,
 int bufferRowLength,
 int bufferImageHeight,
 VkImageSubresourceLayers imageSubresource,
 VkOffset3D imageOffset,
 VkExtent3D imageExtent)

Initializes this struct with the specified values.

set

public VkBufferImageCopy set(VkBufferImageCopy src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkBufferImageCopy malloc()

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

calloc

public static VkBufferImageCopy calloc()

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

create

public static VkBufferImageCopy create()

Returns a new VkBufferImageCopy instance allocated with BufferUtils.

create

public static VkBufferImageCopy create(long address)

Returns a new VkBufferImageCopy instance for the specified memory address.

createSafe

@Nullable
public static VkBufferImageCopy createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkBufferImageCopy.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkBufferImageCopy.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkBufferImageCopy.Buffer create(int capacity)

Returns a new VkBufferImageCopy.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkBufferImageCopy.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

@Nullable
public static VkBufferImageCopy.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkBufferImageCopy mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkBufferImageCopy callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkBufferImageCopy mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkBufferImageCopy callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static VkBufferImageCopy.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static VkBufferImageCopy.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static VkBufferImageCopy.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkBufferImageCopy.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static VkBufferImageCopy malloc(MemoryStack stack)

Returns a new VkBufferImageCopy instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkBufferImageCopy calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nbufferOffset

public static long nbufferOffset(long struct)

Unsafe version of bufferOffset().

nbufferRowLength

public static int nbufferRowLength(long struct)

Unsafe version of bufferRowLength().

nbufferImageHeight

public static int nbufferImageHeight(long struct)

Unsafe version of bufferImageHeight().

nimageSubresource

public static VkImageSubresourceLayers nimageSubresource(long struct)

Unsafe version of imageSubresource().

nimageOffset

public static VkOffset3D nimageOffset(long struct)

Unsafe version of imageOffset().

nimageExtent

public static VkExtent3D nimageExtent(long struct)

Unsafe version of imageExtent().

nbufferOffset

public static void nbufferOffset(long struct,
 long value)

Unsafe version of bufferOffset.

nbufferRowLength

public static void nbufferRowLength(long struct,
 int value)

Unsafe version of bufferRowLength.

nbufferImageHeight

public static void nbufferImageHeight(long struct,
 int value)

Unsafe version of bufferImageHeight.

nimageSubresource

public static void nimageSubresource(long struct,
 VkImageSubresourceLayers value)

Unsafe version of imageSubresource.

nimageOffset

public static void nimageOffset(long struct,
 VkOffset3D value)

Unsafe version of imageOffset.

nimageExtent

public static void nimageExtent(long struct,
 VkExtent3D value)

Unsafe version of imageExtent.