VkImageResolve (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkImageResolve

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkImageResolve
extends org.lwjgl.system.Struct
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
- The layerCount member of srcSubresource and dstSubresource must match
- If either of the calling command’s srcImage or dstImage parameters are of VkImageType IMAGE_TYPE_3D, the baseArrayLayer and layerCount members of both srcSubresource and dstSubresource must be 0 and 1, respectively
- srcOffset.x and (extent.width srcOffset.x) must both be greater than or equal to 0 and less than or equal to the source image subresource width
- srcOffset.y and (extent.height srcOffset.y) must both be greater than or equal to 0 and less than or equal to the source image subresource height
- If the calling command’s srcImage is of type IMAGE_TYPE_1D, then srcOffset.y must be 0 and extent.height must be 1.
- srcOffset.z and (extent.depth srcOffset.z) must both be greater than or equal to 0 and less than or equal to the source image subresource depth
- If the calling command’s srcImage is of type IMAGE_TYPE_1D or IMAGE_TYPE_2D, then srcOffset.z must be 0 and extent.depth must be 1.
- dstOffset.x and (extent.width dstOffset.x) must both be greater than or equal to 0 and less than or equal to the destination image subresource width
- dstOffset.y and (extent.height dstOffset.y) must both be greater than or equal to 0 and less than or equal to the destination image subresource height
- If the calling command’s dstImage is of type IMAGE_TYPE_1D, then dstOffset.y must be 0 and extent.height must be 1.
- dstOffset.z and (extent.depth dstOffset.z) must both be greater than or equal to 0 and less than or equal to the destination image subresource depth
- If the calling command’s dstImage is of type IMAGE_TYPE_1D or IMAGE_TYPE_2D, then dstOffset.z must be 0 and extent.depth must be 1.
Valid Usage (Implicit)
- srcSubresource must be a valid VkImageSubresourceLayers structure
- dstSubresource must be a valid VkImageSubresourceLayers structure
See Also

VkExtent3D, VkImageSubresourceLayers, VkOffset3D, CmdResolveImage

Member documentation
- 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 – 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 – see srcSubresource
- dstOffset – see srcOffset
- extent – the size in texels of the source image to resolve in width, height and depth.
Layout
```
 struct VkImageResolve {
     VkImageSubresourceLayers srcSubresource;
     VkOffset3D srcOffset;
     VkImageSubresourceLayers dstSubresource;
     VkOffset3D dstOffset;
     VkExtent3D extent;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkImageResolve.Buffer
An array of VkImageResolve structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`DSTOFFSET` The struct member offsets.
`static int`	`DSTSUBRESOURCE` The struct member offsets.
`static int`	`EXTENT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`SRCOFFSET` The struct member offsets.
`static 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 and Description

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

Constructors
Constructor and Description
`VkImageResolve(java.nio.ByteBuffer container)` Creates a `VkImageResolve` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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`	`callocStack()` Returns a new `VkImageResolve` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkImageResolve.Buffer`	`callocStack(int capacity)` Returns a new `VkImageResolve.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkImageResolve.Buffer`	`callocStack(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`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkImageResolve` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`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 VkImageResolve`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkImageResolve.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`VkOffset3D`	`dstOffset()` Returns a `VkOffset3D` view of the `dstOffset` field.
`VkImageResolve`	`dstOffset(java.util.function.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()` Returns a `VkImageSubresourceLayers` view of the `dstSubresource` field.
`VkImageResolve`	`dstSubresource(java.util.function.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()` Returns a `VkExtent3D` view of the `extent` field.
`VkImageResolve`	`extent(java.util.function.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`	`mallocStack()` Returns a new `VkImageResolve` instance allocated on the thread-local `MemoryStack`.
`static VkImageResolve.Buffer`	`mallocStack(int capacity)` Returns a new `VkImageResolve.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkImageResolve.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkImageResolve.Buffer` instance allocated on the specified `MemoryStack`.
`static VkImageResolve`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkImageResolve` 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 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()` Returns a `VkOffset3D` view of the `srcOffset` field.
`VkImageResolve`	`srcOffset(java.util.function.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()` Returns a `VkImageSubresourceLayers` view of the `srcSubresource` field.
`VkImageResolve`	`srcSubresource(java.util.function.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

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 Detail
  - 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 Detail
  - VkImageResolve
```
public VkImageResolve(java.nio.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 Detail
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - srcSubresource
```
public VkImageSubresourceLayers srcSubresource()
```
    Returns a VkImageSubresourceLayers view of the srcSubresource field.
  - srcOffset
```
public VkOffset3D srcOffset()
```
    Returns a VkOffset3D view of the srcOffset field.
  - dstSubresource
```
public VkImageSubresourceLayers dstSubresource()
```
    Returns a VkImageSubresourceLayers view of the dstSubresource field.
  - dstOffset
```
public VkOffset3D dstOffset()
```
    Returns a VkOffset3D view of the dstOffset field.
  - extent
```
public VkExtent3D extent()
```
    Returns a VkExtent3D view of the extent field.
  - srcSubresource
```
public VkImageResolve srcSubresource(VkImageSubresourceLayers value)
```
    Copies the specified VkImageSubresourceLayers to the srcSubresource field.
  - srcSubresource
```
public VkImageResolve srcSubresource(java.util.function.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(java.util.function.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(java.util.function.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(java.util.function.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(java.util.function.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
```
@Nullable
public static 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
```
@Nullable
public static VkImageResolve.Buffer createSafe(long address,
                                                         int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkImageResolve mallocStack()
```
    Returns a new VkImageResolve instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkImageResolve callocStack()
```
    Returns a new VkImageResolve instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkImageResolve mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkImageResolve instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkImageResolve callocStack(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
  - mallocStack
```
public static VkImageResolve.Buffer mallocStack(int capacity)
```
    Returns a new VkImageResolve.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkImageResolve.Buffer callocStack(int capacity)
```
    Returns a new VkImageResolve.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkImageResolve.Buffer mallocStack(int capacity,
                                                org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkImageResolve.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkImageResolve.Buffer callocStack(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:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - 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.

Class VkImageResolve

Valid Usage

Valid Usage (Implicit)

See Also

Member documentation

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

SRCSUBRESOURCE

SRCOFFSET

DSTSUBRESOURCE

DSTOFFSET

EXTENT

Constructor Detail

VkImageResolve

Method Detail

sizeof

srcSubresource

srcOffset

dstSubresource

dstOffset

extent

srcSubresource

srcSubresource

srcOffset

srcOffset

dstSubresource

dstSubresource

dstOffset

dstOffset

extent

extent

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsrcSubresource

nsrcOffset

ndstSubresource

ndstOffset

nextent

nsrcSubresource

nsrcOffset

ndstSubresource

ndstOffset

nextent