Package org.lwjgl.vulkan

Class VkImageBlit

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct

org.lwjgl.vulkan.VkImageBlit

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkImageBlit
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource

Structure specifying an image blit operation.

Description

For each element of the pRegions array, a blit operation is performed for the specified source and destination regions.

Valid Usage

• The aspectMask member of srcSubresource and dstSubresource must match
• The layerCount member of srcSubresource and dstSubresource must match

Valid Usage (Implicit)

• srcSubresource must be a valid VkImageSubresourceLayers structure
• dstSubresource must be a valid VkImageSubresourceLayers structure

See Also

VkImageSubresourceLayers, VkOffset3D, CmdBlitImage

Layout

 struct VkImageBlit {
     VkImageSubresourceLayers srcSubresource();
     VkOffset3D srcOffsets()[2];
     VkImageSubresourceLayers dstSubresource();
     VkOffset3D dstOffsets()[2];
 }

Nested Class Summary

Nested Classes

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

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

org.lwjgl.system.Pointer.Default

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

org.lwjgl.system.Struct.StructValidation

Field Summary

Fields

Modifier and Type	Field	Description
static int	ALIGNOF	The struct alignment in bytes.
static int	DSTOFFSETS DSTSUBRESOURCE	The struct member offsets.
static int	SIZEOF	The struct size in bytes.
static int	SRCOFFSETS SRCSUBRESOURCE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkImageBlit	calloc()	Returns a new VkImageBlit instance allocated with memCalloc.
static VkImageBlit.Buffer	calloc(int capacity)	Returns a new VkImageBlit.Buffer instance allocated with memCalloc.
static VkImageBlit.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImageBlit.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageBlit	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImageBlit instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageBlit	callocStack()	Deprecated.
static VkImageBlit.Buffer	callocStack(int capacity)	Deprecated.
static VkImageBlit.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkImageBlit	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkImageBlit	create()	Returns a new VkImageBlit instance allocated with BufferUtils.
static VkImageBlit.Buffer	create(int capacity)	Returns a new VkImageBlit.Buffer instance allocated with BufferUtils.
static VkImageBlit	create(long address)	Returns a new VkImageBlit instance for the specified memory address.
static VkImageBlit.Buffer	create(long address, int capacity)	Create a VkImageBlit.Buffer instance at the specified memory.
static VkImageBlit	createSafe(long address)	Like create, but returns null if address is NULL.
static VkImageBlit.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkOffset3D.Buffer	dstOffsets()	a pointer to an array of two VkOffset3D structures specifying the bounds of the destination region within dstSubresource.
VkOffset3D	dstOffsets(int index)	a pointer to an array of two VkOffset3D structures specifying the bounds of the destination region within dstSubresource.
VkImageBlit	dstOffsets(int index, java.util.function.Consumer<VkOffset3D> consumer)	Passes the element at index of the dstOffsets() field to the specified Consumer.
VkImageBlit	dstOffsets(int index, VkOffset3D value)	Copies the specified VkOffset3D at the specified index of the dstOffsets() field.
VkImageBlit	dstOffsets(java.util.function.Consumer<VkOffset3D.Buffer> consumer)	Passes the dstOffsets() field to the specified Consumer.
VkImageBlit	dstOffsets(VkOffset3D.Buffer value)	Copies the specified VkOffset3D.Buffer to the dstOffsets() field.
VkImageSubresourceLayers	dstSubresource()	the subresource to blit into.
VkImageBlit	dstSubresource(java.util.function.Consumer<VkImageSubresourceLayers> consumer)	Passes the dstSubresource() field to the specified Consumer.
VkImageBlit	dstSubresource(VkImageSubresourceLayers value)	Copies the specified VkImageSubresourceLayers to the dstSubresource() field.
static VkImageBlit	malloc()	Returns a new VkImageBlit instance allocated with memAlloc.
static VkImageBlit.Buffer	malloc(int capacity)	Returns a new VkImageBlit.Buffer instance allocated with memAlloc.
static VkImageBlit.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImageBlit.Buffer instance allocated on the specified MemoryStack.
static VkImageBlit	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImageBlit instance allocated on the specified MemoryStack.
static VkImageBlit	mallocStack()	Deprecated.
static VkImageBlit.Buffer	mallocStack(int capacity)	Deprecated.
static VkImageBlit.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkImageBlit	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkOffset3D.Buffer	ndstOffsets(long struct)	Unsafe version of dstOffsets().
static VkOffset3D	ndstOffsets(long struct, int index)	Unsafe version of dstOffsets.
static void	ndstOffsets(long struct, int index, VkOffset3D value)	Unsafe version of dstOffsets.
static void	ndstOffsets(long struct, VkOffset3D.Buffer value)	Unsafe version of dstOffsets.
static VkImageSubresourceLayers	ndstSubresource(long struct)	Unsafe version of dstSubresource().
static void	ndstSubresource(long struct, VkImageSubresourceLayers value)	Unsafe version of dstSubresource.
static VkOffset3D.Buffer	nsrcOffsets(long struct)	Unsafe version of srcOffsets().
static VkOffset3D	nsrcOffsets(long struct, int index)	Unsafe version of srcOffsets.
static void	nsrcOffsets(long struct, int index, VkOffset3D value)	Unsafe version of srcOffsets.
static void	nsrcOffsets(long struct, VkOffset3D.Buffer value)	Unsafe version of srcOffsets.
static VkImageSubresourceLayers	nsrcSubresource(long struct)	Unsafe version of srcSubresource().
static void	nsrcSubresource(long struct, VkImageSubresourceLayers value)	Unsafe version of srcSubresource.
VkImageBlit	set(VkImageBlit src)	Copies the specified struct data to this struct.
VkImageBlit	set(VkImageSubresourceLayers srcSubresource, VkOffset3D.Buffer srcOffsets, VkImageSubresourceLayers dstSubresource, VkOffset3D.Buffer dstOffsets)	Initializes this struct with the specified values.
int	sizeof()
VkOffset3D.Buffer	srcOffsets()	a pointer to an array of two VkOffset3D structures specifying the bounds of the source region within srcSubresource.
VkOffset3D	srcOffsets(int index)	a pointer to an array of two VkOffset3D structures specifying the bounds of the source region within srcSubresource.
VkImageBlit	srcOffsets(int index, java.util.function.Consumer<VkOffset3D> consumer)	Passes the element at index of the srcOffsets() field to the specified Consumer.
VkImageBlit	srcOffsets(int index, VkOffset3D value)	Copies the specified VkOffset3D at the specified index of the srcOffsets() field.
VkImageBlit	srcOffsets(java.util.function.Consumer<VkOffset3D.Buffer> consumer)	Passes the srcOffsets() field to the specified Consumer.
VkImageBlit	srcOffsets(VkOffset3D.Buffer value)	Copies the specified VkOffset3D.Buffer to the srcOffsets() field.
VkImageSubresourceLayers	srcSubresource()	the subresource to blit from.
VkImageBlit	srcSubresource(java.util.function.Consumer<VkImageSubresourceLayers> consumer)	Passes the srcSubresource() field to the specified Consumer.
VkImageBlit	srcSubresource(VkImageSubresourceLayers value)	Copies the specified VkImageSubresourceLayers to the srcSubresource() field.

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

Field Detail

SIZEOF

The struct size in bytes.

ALIGNOF

The struct alignment in bytes.

SRCSUBRESOURCE, SRCOFFSETS, DSTSUBRESOURCE, DSTOFFSETS

The struct member offsets.

Constructor Detail

VkImageBlit

public VkImageBlit(java.nio.ByteBuffer container)

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

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct

srcSubresource

public VkImageSubresourceLayers srcSubresource()

the subresource to blit from.

srcOffsets

public VkOffset3D.Buffer srcOffsets()

public VkOffset3D srcOffsets(int index)

a pointer to an array of two VkOffset3D structures specifying the bounds of the source region within srcSubresource.

dstSubresource

public VkImageSubresourceLayers dstSubresource()

the subresource to blit into.

dstOffsets

public VkOffset3D.Buffer dstOffsets()

public VkOffset3D dstOffsets(int index)

a pointer to an array of two VkOffset3D structures specifying the bounds of the destination region within dstSubresource.

srcSubresource

public VkImageBlit srcSubresource(VkImageSubresourceLayers value)

Copies the specified VkImageSubresourceLayers to the srcSubresource() field.

srcSubresource

public VkImageBlit srcSubresource(java.util.function.Consumer<VkImageSubresourceLayers> consumer)

Passes the srcSubresource() field to the specified Consumer.

srcOffsets

public VkImageBlit srcOffsets(VkOffset3D.Buffer value)

Copies the specified VkOffset3D.Buffer to the srcOffsets() field.

srcOffsets

public VkImageBlit srcOffsets(int index,
                              VkOffset3D value)

Copies the specified VkOffset3D at the specified index of the srcOffsets() field.

srcOffsets

public VkImageBlit srcOffsets(java.util.function.Consumer<VkOffset3D.Buffer> consumer)

Passes the srcOffsets() field to the specified Consumer.

srcOffsets

public VkImageBlit srcOffsets(int index,
                              java.util.function.Consumer<VkOffset3D> consumer)

Passes the element at index of the srcOffsets() field to the specified Consumer.

dstSubresource

public VkImageBlit dstSubresource(VkImageSubresourceLayers value)

Copies the specified VkImageSubresourceLayers to the dstSubresource() field.

dstSubresource

public VkImageBlit dstSubresource(java.util.function.Consumer<VkImageSubresourceLayers> consumer)

Passes the dstSubresource() field to the specified Consumer.

dstOffsets

public VkImageBlit dstOffsets(VkOffset3D.Buffer value)

Copies the specified VkOffset3D.Buffer to the dstOffsets() field.

dstOffsets

public VkImageBlit dstOffsets(int index,
                              VkOffset3D value)

Copies the specified VkOffset3D at the specified index of the dstOffsets() field.

dstOffsets

public VkImageBlit dstOffsets(java.util.function.Consumer<VkOffset3D.Buffer> consumer)

Passes the dstOffsets() field to the specified Consumer.

dstOffsets

public VkImageBlit dstOffsets(int index,
                              java.util.function.Consumer<VkOffset3D> consumer)

Passes the element at index of the dstOffsets() field to the specified Consumer.

set

public VkImageBlit set(VkImageSubresourceLayers srcSubresource,
                       VkOffset3D.Buffer srcOffsets,
                       VkImageSubresourceLayers dstSubresource,
                       VkOffset3D.Buffer dstOffsets)

Initializes this struct with the specified values.

set

public VkImageBlit set(VkImageBlit src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkImageBlit malloc()

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

calloc

public static VkImageBlit calloc()

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

create

public static VkImageBlit create()

Returns a new VkImageBlit instance allocated with BufferUtils.

create

public static VkImageBlit create(long address)

Returns a new VkImageBlit instance for the specified memory address.

createSafe

@Nullable
public static VkImageBlit createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkImageBlit.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkImageBlit.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkImageBlit.Buffer create(int capacity)

Returns a new VkImageBlit.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkImageBlit.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkImageBlit mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkImageBlit callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkImageBlit mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkImageBlit callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkImageBlit.Buffer mallocStack(int capacity,
                                             org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkImageBlit.Buffer callocStack(int capacity,
                                             org.lwjgl.system.MemoryStack stack)

Deprecated.

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

malloc

public static VkImageBlit malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkImageBlit instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkImageBlit calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkImageBlit.Buffer malloc(int capacity,
                                        org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

capacity - the buffer capacity

calloc

public static VkImageBlit.Buffer calloc(int capacity,
                                        org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

capacity - the buffer capacity

nsrcSubresource

public static VkImageSubresourceLayers nsrcSubresource(long struct)

Unsafe version of srcSubresource().

nsrcOffsets

public static VkOffset3D.Buffer nsrcOffsets(long struct)

Unsafe version of srcOffsets().

nsrcOffsets

public static VkOffset3D nsrcOffsets(long struct,
                                     int index)

Unsafe version of srcOffsets.

ndstSubresource

public static VkImageSubresourceLayers ndstSubresource(long struct)

Unsafe version of dstSubresource().

ndstOffsets

public static VkOffset3D.Buffer ndstOffsets(long struct)

Unsafe version of dstOffsets().

ndstOffsets

public static VkOffset3D ndstOffsets(long struct,
                                     int index)

Unsafe version of dstOffsets.

nsrcSubresource

public static void nsrcSubresource(long struct,
                                   VkImageSubresourceLayers value)

Unsafe version of srcSubresource.

nsrcOffsets

public static void nsrcOffsets(long struct,
                               VkOffset3D.Buffer value)

Unsafe version of srcOffsets.

nsrcOffsets

public static void nsrcOffsets(long struct,
                               int index,
                               VkOffset3D value)

Unsafe version of srcOffsets.

ndstSubresource

public static void ndstSubresource(long struct,
                                   VkImageSubresourceLayers value)

Unsafe version of dstSubresource.

ndstOffsets

public static void ndstOffsets(long struct,
                               VkOffset3D.Buffer value)

Unsafe version of dstOffsets.

ndstOffsets

public static void ndstOffsets(long struct,
                               int index,
                               VkOffset3D value)

Unsafe version of dstOffsets.