Package org.lwjgl.vulkan

Class VkImageResolve2

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkImageResolve2>

org.lwjgl.vulkan.VkImageResolve2

All Implemented Interfaces:

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

Direct Known Subclasses:

VkImageResolve2KHR

public class VkImageResolve2
extends org.lwjgl.system.Struct<VkImageResolve2>
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)

• sType must be STRUCTURE_TYPE_IMAGE_RESOLVE_2
• pNext must be NULL
• srcSubresource must be a valid VkImageSubresourceLayers structure
• dstSubresource must be a valid VkImageSubresourceLayers structure

See Also

VkExtent3D, VkImageSubresourceLayers, VkOffset3D, VkResolveImageInfo2

Layout

 struct VkImageResolve2 {
     VkStructureType sType();
     void const * pNext();
     VkImageSubresourceLayers srcSubresource();
     VkOffset3D srcOffset();
     VkImageSubresourceLayers dstSubresource();
     VkOffset3D dstOffset();
     VkExtent3D extent();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkImageResolve2.Buffer	An array of VkImageResolve2 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	PNEXT	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.
static final int	STYPE	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
VkImageResolve2(ByteBuffer container)	Creates a VkImageResolve2 instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkImageResolve2	calloc()	Returns a new VkImageResolve2 instance allocated with memCalloc.
static VkImageResolve2.Buffer	calloc(int capacity)	Returns a new VkImageResolve2.Buffer instance allocated with memCalloc.
static VkImageResolve2.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImageResolve2.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageResolve2	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImageResolve2 instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageResolve2	create()	Returns a new VkImageResolve2 instance allocated with BufferUtils.
static VkImageResolve2.Buffer	create(int capacity)	Returns a new VkImageResolve2.Buffer instance allocated with BufferUtils.
static VkImageResolve2	create(long address)	Returns a new VkImageResolve2 instance for the specified memory address.
static VkImageResolve2.Buffer	create(long address, int capacity)	Create a VkImageResolve2.Buffer instance at the specified memory.
static @Nullable VkImageResolve2	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkImageResolve2.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkOffset3D	dstOffset()	see srcOffset
VkImageResolve2	dstOffset(Consumer<VkOffset3D> consumer)	Passes the dstOffset() field to the specified Consumer.
VkImageResolve2	dstOffset(VkOffset3D value)	Copies the specified VkOffset3D to the dstOffset() field.
VkImageSubresourceLayers	dstSubresource()	see srcSubresource
VkImageResolve2	dstSubresource(Consumer<VkImageSubresourceLayers> consumer)	Passes the dstSubresource() field to the specified Consumer.
VkImageResolve2	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.
VkImageResolve2	extent(Consumer<VkExtent3D> consumer)	Passes the extent() field to the specified Consumer.
VkImageResolve2	extent(VkExtent3D value)	Copies the specified VkExtent3D to the extent() field.
static VkImageResolve2	malloc()	Returns a new VkImageResolve2 instance allocated with memAlloc.
static VkImageResolve2.Buffer	malloc(int capacity)	Returns a new VkImageResolve2.Buffer instance allocated with memAlloc.
static VkImageResolve2.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImageResolve2.Buffer instance allocated on the specified MemoryStack.
static VkImageResolve2	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImageResolve2 instance allocated on the specified MemoryStack.
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 long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
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.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkImageResolve2	pNext(long value)	Sets the specified value to the pNext() field.
VkImageResolve2	set(int sType, long pNext, VkImageSubresourceLayers srcSubresource, VkOffset3D srcOffset, VkImageSubresourceLayers dstSubresource, VkOffset3D dstOffset, VkExtent3D extent)	Initializes this struct with the specified values.
VkImageResolve2	set(VkImageResolve2 src)	Copies the specified struct data to this struct.
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.
VkImageResolve2	srcOffset(Consumer<VkOffset3D> consumer)	Passes the srcOffset() field to the specified Consumer.
VkImageResolve2	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.
VkImageResolve2	srcSubresource(Consumer<VkImageSubresourceLayers> consumer)	Passes the srcSubresource() field to the specified Consumer.
VkImageResolve2	srcSubresource(VkImageSubresourceLayers value)	Copies the specified VkImageSubresourceLayers to the srcSubresource() field.
int	sType()	a VkStructureType value identifying this structure.
VkImageResolve2	sType(int value)	Sets the specified value to the sType() field.
VkImageResolve2	sType$Default()	Sets the STRUCTURE_TYPE_IMAGE_RESOLVE_2 value to the sType() 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.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

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

VkImageResolve2

public VkImageResolve2(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

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.

sType

public VkImageResolve2 sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkImageResolve2 sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_RESOLVE_2 value to the sType() field.

pNext

public VkImageResolve2 pNext(long value)

Sets the specified value to the pNext() field.

srcSubresource

public VkImageResolve2 srcSubresource(VkImageSubresourceLayers value)

Copies the specified VkImageSubresourceLayers to the srcSubresource() field.

srcSubresource

public VkImageResolve2 srcSubresource(Consumer<VkImageSubresourceLayers> consumer)

Passes the srcSubresource() field to the specified Consumer.

srcOffset

public VkImageResolve2 srcOffset(VkOffset3D value)

Copies the specified VkOffset3D to the srcOffset() field.

srcOffset

public VkImageResolve2 srcOffset(Consumer<VkOffset3D> consumer)

Passes the srcOffset() field to the specified Consumer.

dstSubresource

public VkImageResolve2 dstSubresource(VkImageSubresourceLayers value)

Copies the specified VkImageSubresourceLayers to the dstSubresource() field.

dstSubresource

public VkImageResolve2 dstSubresource(Consumer<VkImageSubresourceLayers> consumer)

Passes the dstSubresource() field to the specified Consumer.

dstOffset

public VkImageResolve2 dstOffset(VkOffset3D value)

Copies the specified VkOffset3D to the dstOffset() field.

dstOffset

public VkImageResolve2 dstOffset(Consumer<VkOffset3D> consumer)

Passes the dstOffset() field to the specified Consumer.

extent

public VkImageResolve2 extent(VkExtent3D value)

Copies the specified VkExtent3D to the extent() field.

extent

public VkImageResolve2 extent(Consumer<VkExtent3D> consumer)

Passes the extent() field to the specified Consumer.

set

public VkImageResolve2 set(int sType,
 long pNext,
 VkImageSubresourceLayers srcSubresource,
 VkOffset3D srcOffset,
 VkImageSubresourceLayers dstSubresource,
 VkOffset3D dstOffset,
 VkExtent3D extent)

Initializes this struct with the specified values.

set

public VkImageResolve2 set(VkImageResolve2 src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkImageResolve2 malloc()

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

calloc

public static VkImageResolve2 calloc()

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

create

public static VkImageResolve2 create()

Returns a new VkImageResolve2 instance allocated with BufferUtils.

create

public static VkImageResolve2 create(long address)

Returns a new VkImageResolve2 instance for the specified memory address.

createSafe

public static @Nullable VkImageResolve2 createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkImageResolve2.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkImageResolve2.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkImageResolve2.Buffer create(int capacity)

Returns a new VkImageResolve2.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkImageResolve2.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkImageResolve2 instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

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().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

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.