Package org.lwjgl.vulkan

Class VkImageResolve

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkImageResolve>

org.lwjgl.vulkan.VkImageResolve

All Implemented Interfaces:

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

public class VkImageResolve
extends org.lwjgl.system.Struct<VkImageResolve>
implements org.lwjgl.system.NativeResource

Structure specifying an image resolve operation.

Valid Usage

• The aspectMask member of srcSubresource and dstSubresource must only contain IMAGE_ASPECT_COLOR_BIT
• If neither of the layerCount members of srcSubresource or dstSubresource are REMAINING_ARRAY_LAYERS, the layerCount member of srcSubresource and dstSubresource must match
• If one of the layerCount members of srcSubresource or dstSubresource is REMAINING_ARRAY_LAYERS, the other member must be either REMAINING_ARRAY_LAYERS or equal to the arrayLayers member of the VkImageCreateInfo used to create the image minus baseArrayLayer

Valid Usage (Implicit)

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

See Also

VkExtent3D, VkImageSubresourceLayers, VkOffset3D, CmdResolveImage

Layout

 struct VkImageResolve {
     VkImageSubresourceLayers srcSubresource();
     VkOffset3D srcOffset();
     VkImageSubresourceLayers dstSubresource();
     VkOffset3D dstOffset();
     VkExtent3D extent();
 }

Nested Class Summary

Nested Classes

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

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

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	DSTOFFSET	The struct member offsets.
static final int	DSTSUBRESOURCE	The struct member offsets.
static final int	EXTENT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SRCOFFSET	The struct member offsets.
static final int	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
VkImageResolve(ByteBuffer container)	Creates a VkImageResolve instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkImageResolve	calloc()	Returns a new VkImageResolve instance allocated with memCalloc.
static VkImageResolve.Buffer	calloc(int capacity)	Returns a new VkImageResolve.Buffer instance allocated with memCalloc.
static VkImageResolve.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImageResolve.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageResolve	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImageResolve instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageResolve	callocStack()	Deprecated.
static VkImageResolve.Buffer	callocStack(int capacity)	Deprecated.
static VkImageResolve.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkImageResolve	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkImageResolve	create()	Returns a new VkImageResolve instance allocated with BufferUtils.
static VkImageResolve.Buffer	create(int capacity)	Returns a new VkImageResolve.Buffer instance allocated with BufferUtils.
static VkImageResolve	create(long address)	Returns a new VkImageResolve instance for the specified memory address.
static VkImageResolve.Buffer	create(long address, int capacity)	Create a VkImageResolve.Buffer instance at the specified memory.
static @Nullable VkImageResolve	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkImageResolve.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkOffset3D	dstOffset()	see srcOffset
VkImageResolve	dstOffset(Consumer<VkOffset3D> consumer)	Passes the dstOffset() field to the specified Consumer.
VkImageResolve	dstOffset(VkOffset3D value)	Copies the specified VkOffset3D to the dstOffset() field.
VkImageSubresourceLayers	dstSubresource()	see srcSubresource
VkImageResolve	dstSubresource(Consumer<VkImageSubresourceLayers> consumer)	Passes the dstSubresource() field to the specified Consumer.
VkImageResolve	dstSubresource(VkImageSubresourceLayers value)	Copies the specified VkImageSubresourceLayers to the dstSubresource() field.
VkExtent3D	extent()	the size in texels of the source image to resolve in width, height and depth.
VkImageResolve	extent(Consumer<VkExtent3D> consumer)	Passes the extent() field to the specified Consumer.
VkImageResolve	extent(VkExtent3D value)	Copies the specified VkExtent3D to the extent() field.
static VkImageResolve	malloc()	Returns a new VkImageResolve instance allocated with memAlloc.
static VkImageResolve.Buffer	malloc(int capacity)	Returns a new VkImageResolve.Buffer instance allocated with memAlloc.
static VkImageResolve.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImageResolve.Buffer instance allocated on the specified MemoryStack.
static VkImageResolve	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImageResolve instance allocated on the specified MemoryStack.
static VkImageResolve	mallocStack()	Deprecated.
static VkImageResolve.Buffer	mallocStack(int capacity)	Deprecated.
static VkImageResolve.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkImageResolve	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkOffset3D	ndstOffset(long struct)	Unsafe version of dstOffset().
static void	ndstOffset(long struct, VkOffset3D value)	Unsafe version of dstOffset.
static VkImageSubresourceLayers	ndstSubresource(long struct)	Unsafe version of dstSubresource().
static void	ndstSubresource(long struct, VkImageSubresourceLayers value)	Unsafe version of dstSubresource.
static VkExtent3D	nextent(long struct)	Unsafe version of extent().
static void	nextent(long struct, VkExtent3D value)	Unsafe version of extent.
static VkOffset3D	nsrcOffset(long struct)	Unsafe version of srcOffset().
static void	nsrcOffset(long struct, VkOffset3D value)	Unsafe version of srcOffset.
static VkImageSubresourceLayers	nsrcSubresource(long struct)	Unsafe version of srcSubresource().
static void	nsrcSubresource(long struct, VkImageSubresourceLayers value)	Unsafe version of srcSubresource.
VkImageResolve	set(VkImageResolve src)	Copies the specified struct data to this struct.
VkImageResolve	set(VkImageSubresourceLayers srcSubresource, VkOffset3D srcOffset, VkImageSubresourceLayers dstSubresource, VkOffset3D dstOffset, VkExtent3D extent)	Initializes this struct with the specified values.
int	sizeof()
VkOffset3D	srcOffset()	srcOffset and dstOffset select the initial x, y, and z offsets in texels of the sub-regions of the source and destination image data.
VkImageResolve	srcOffset(Consumer<VkOffset3D> consumer)	Passes the srcOffset() field to the specified Consumer.
VkImageResolve	srcOffset(VkOffset3D value)	Copies the specified VkOffset3D to the srcOffset() field.
VkImageSubresourceLayers	srcSubresource()	srcSubresource and dstSubresource are VkImageSubresourceLayers structures specifying the image subresources of the images used for the source and destination image data, respectively.
VkImageResolve	srcSubresource(Consumer<VkImageSubresourceLayers> consumer)	Passes the srcSubresource() field to the specified Consumer.
VkImageResolve	srcSubresource(VkImageSubresourceLayers value)	Copies the specified VkImageSubresourceLayers to the srcSubresource() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, 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.

SRCSUBRESOURCE

public static final int SRCSUBRESOURCE

The struct member offsets.

SRCOFFSET

public static final int SRCOFFSET

The struct member offsets.

DSTSUBRESOURCE

public static final int DSTSUBRESOURCE

The struct member offsets.

DSTOFFSET

public static final int DSTOFFSET

The struct member offsets.

EXTENT

public static final int EXTENT

The struct member offsets.

Constructor Details

VkImageResolve

public VkImageResolve(ByteBuffer container)

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

Specified by:

sizeof in class org.lwjgl.system.Struct<VkImageResolve>

srcSubresource

public VkImageSubresourceLayers srcSubresource()

srcSubresource and dstSubresource are VkImageSubresourceLayers structures specifying the image subresources of the images used for the source and destination image data, respectively. Resolve of depth/stencil images is not supported.

srcOffset

public VkOffset3D srcOffset()

srcOffset and dstOffset select the initial x, y, and z offsets in texels of the sub-regions of the source and destination image data.

dstSubresource

public VkImageSubresourceLayers dstSubresource()

see srcSubresource

dstOffset

public VkOffset3D dstOffset()

see srcOffset

extent

public VkExtent3D extent()

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

srcSubresource

public VkImageResolve srcSubresource(VkImageSubresourceLayers value)

Copies the specified VkImageSubresourceLayers to the srcSubresource() field.

srcSubresource

public VkImageResolve srcSubresource(Consumer<VkImageSubresourceLayers> consumer)

Passes the srcSubresource() field to the specified Consumer.

srcOffset

public VkImageResolve srcOffset(VkOffset3D value)

Copies the specified VkOffset3D to the srcOffset() field.

srcOffset

public VkImageResolve srcOffset(Consumer<VkOffset3D> consumer)

Passes the srcOffset() field to the specified Consumer.

dstSubresource

public VkImageResolve dstSubresource(VkImageSubresourceLayers value)

Copies the specified VkImageSubresourceLayers to the dstSubresource() field.

dstSubresource

public VkImageResolve dstSubresource(Consumer<VkImageSubresourceLayers> consumer)

Passes the dstSubresource() field to the specified Consumer.

dstOffset

public VkImageResolve dstOffset(VkOffset3D value)

Copies the specified VkOffset3D to the dstOffset() field.

dstOffset

public VkImageResolve dstOffset(Consumer<VkOffset3D> consumer)

Passes the dstOffset() field to the specified Consumer.

extent

public VkImageResolve extent(VkExtent3D value)

Copies the specified VkExtent3D to the extent() field.

extent

public VkImageResolve extent(Consumer<VkExtent3D> consumer)

Passes the extent() field to the specified Consumer.

set

public VkImageResolve set(VkImageSubresourceLayers srcSubresource,
 VkOffset3D srcOffset,
 VkImageSubresourceLayers dstSubresource,
 VkOffset3D dstOffset,
 VkExtent3D extent)

Initializes this struct with the specified values.

set

public VkImageResolve set(VkImageResolve src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkImageResolve malloc()

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

calloc

public static VkImageResolve calloc()

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

create

public static VkImageResolve create()

Returns a new VkImageResolve instance allocated with BufferUtils.

create

public static VkImageResolve create(long address)

Returns a new VkImageResolve instance for the specified memory address.

createSafe

public static @Nullable VkImageResolve createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkImageResolve.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkImageResolve.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkImageResolve.Buffer create(int capacity)

Returns a new VkImageResolve.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkImageResolve.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkImageResolve mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkImageResolve callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkImageResolve.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 VkImageResolve.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 VkImageResolve malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkImageResolve instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsrcSubresource

public static VkImageSubresourceLayers nsrcSubresource(long struct)

Unsafe version of srcSubresource().

nsrcOffset

public static VkOffset3D nsrcOffset(long struct)

Unsafe version of srcOffset().

ndstSubresource

public static VkImageSubresourceLayers ndstSubresource(long struct)

Unsafe version of dstSubresource().

ndstOffset

public static VkOffset3D ndstOffset(long struct)

Unsafe version of dstOffset().

nextent

public static VkExtent3D nextent(long struct)

Unsafe version of extent().

nsrcSubresource

public static void nsrcSubresource(long struct,
 VkImageSubresourceLayers value)

Unsafe version of srcSubresource.

nsrcOffset

public static void nsrcOffset(long struct,
 VkOffset3D value)

Unsafe version of srcOffset.

ndstSubresource

public static void ndstSubresource(long struct,
 VkImageSubresourceLayers value)

Unsafe version of dstSubresource.

ndstOffset

public static void ndstOffset(long struct,
 VkOffset3D value)

Unsafe version of dstOffset.

nextent

public static void nextent(long struct,
 VkExtent3D value)

Unsafe version of extent.