VkImageBlit (LWJGL 3.2.4 SNAPSHOT

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 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
- 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
- The aspectMask member of srcSubresource must specify aspects present in the calling command’s srcImage
- The aspectMask member of dstSubresource must specify aspects present in the calling command’s dstImage
- srcOffset[0].x and srcOffset[1].x must both be greater than or equal to 0 and less than or equal to the source image subresource width
- srcOffset[0].y and srcOffset[1].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[0].y must be 0 and srcOffset[1].y must be 1.
- srcOffset[0].z and srcOffset[1].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[0].z must be 0 and srcOffset[1].z must be 1.
- dstOffset[0].x and dstOffset[1].x must both be greater than or equal to 0 and less than or equal to the destination image subresource width
- dstOffset[0].y and dstOffset[1].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[0].y must be 0 and dstOffset[1].y must be 1.
- dstOffset[0].z and dstOffset[1].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[0].z must be 0 and dstOffset[1].z must be 1.
Valid Usage (Implicit)
- srcSubresource must be a valid VkImageSubresourceLayers structure
- dstSubresource must be a valid VkImageSubresourceLayers structure
See Also

VkImageSubresourceLayers, VkOffset3D, CmdBlitImage

Member documentation
- srcSubresource – the subresource to blit from.
- srcOffsets[2] – a pointer to an array of two VkOffset3D structures specifying the bounds of the source region within srcSubresource.
- dstSubresource – the subresource to blit into.
- dstOffsets[2] – a pointer to an array of two VkOffset3D structures specifying the bounds of the destination region within dstSubresource.
Layout
```
 struct VkImageBlit {
     VkImageSubresourceLayers srcSubresource;
     VkOffset3D srcOffsets[2];
     VkImageSubresourceLayers dstSubresource;
     VkOffset3D dstOffsets[2];
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and 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
Modifier and Type	Class and Description
`static class`	`VkImageBlit.Buffer` An array of `VkImageBlit` structs.

Field Summary

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

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

Constructors
Constructor and Description
`VkImageBlit(java.nio.ByteBuffer container)` Creates a `VkImageBlit` 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 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`	`callocStack()` Returns a new `VkImageBlit` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkImageBlit.Buffer`	`callocStack(int capacity)` Returns a new `VkImageBlit.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkImageBlit.Buffer`	`callocStack(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`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkImageBlit` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`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()` Returns a `VkOffset3D`.Buffer view of the `dstOffsets` field.
`VkImageBlit`	`dstOffsets(java.util.function.Consumer<VkOffset3D.Buffer> consumer)` Passes the `dstOffsets` field to the specified `Consumer`.
`VkOffset3D`	`dstOffsets(int index)` Returns a `VkOffset3D` view of the struct at the specified index of the `dstOffsets` field.
`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(VkOffset3D.Buffer value)` Copies the specified `VkOffset3D.Buffer` to the `dstOffsets` field.
`VkImageSubresourceLayers`	`dstSubresource()` Returns a `VkImageSubresourceLayers` view of the `dstSubresource` field.
`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`	`mallocStack()` Returns a new `VkImageBlit` instance allocated on the thread-local `MemoryStack`.
`static VkImageBlit.Buffer`	`mallocStack(int capacity)` Returns a new `VkImageBlit.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkImageBlit.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkImageBlit.Buffer` instance allocated on the specified `MemoryStack`.
`static VkImageBlit`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkImageBlit` instance allocated on the specified `MemoryStack`.
`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()` Returns a `VkOffset3D`.Buffer view of the `srcOffsets` field.
`VkImageBlit`	`srcOffsets(java.util.function.Consumer<VkOffset3D.Buffer> consumer)` Passes the `srcOffsets` field to the specified `Consumer`.
`VkOffset3D`	`srcOffsets(int index)` Returns a `VkOffset3D` view of the struct at the specified index of the `srcOffsets` field.
`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(VkOffset3D.Buffer value)` Copies the specified `VkOffset3D.Buffer` to the `srcOffsets` field.
`VkImageSubresourceLayers`	`srcSubresource()` Returns a `VkImageSubresourceLayers` view of the `srcSubresource` field.
`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 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.
- SRCOFFSETS
```
public static final int SRCOFFSETS
```
  The struct member offsets.
- DSTSUBRESOURCE
```
public static final int DSTSUBRESOURCE
```
  The struct member offsets.
- DSTOFFSETS
```
public static final int 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()
```
Returns a VkImageSubresourceLayers view of the srcSubresource field.

srcOffsets
```
public VkOffset3D.Buffer srcOffsets()
```
Returns a VkOffset3D.Buffer view of the srcOffsets field.

srcOffsets
```
public VkOffset3D srcOffsets(int index)
```
Returns a VkOffset3D view of the struct at the specified index of the srcOffsets field.

dstSubresource
```
public VkImageSubresourceLayers dstSubresource()
```
Returns a VkImageSubresourceLayers view of the dstSubresource field.

dstOffsets
```
public VkOffset3D.Buffer dstOffsets()
```
Returns a VkOffset3D.Buffer view of the dstOffsets field.

dstOffsets
```
public VkOffset3D dstOffsets(int index)
```
Returns a VkOffset3D view of the struct at the specified index of the dstOffsets field.

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
```
public static VkImageBlit mallocStack()
```
Returns a new VkImageBlit instance allocated on the thread-local MemoryStack.

callocStack
```
public static VkImageBlit callocStack()
```
Returns a new VkImageBlit instance allocated on the thread-local MemoryStack and initializes all its bits to zero.

mallocStack
```
public static VkImageBlit mallocStack(org.lwjgl.system.MemoryStack stack)
```
Returns a new VkImageBlit instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

callocStack
```
public static VkImageBlit callocStack(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

mallocStack
```
public static VkImageBlit.Buffer mallocStack(int capacity)
```
Returns a new VkImageBlit.Buffer instance allocated on the thread-local MemoryStack.

Parameters:

capacity - the buffer capacity

callocStack
```
public static VkImageBlit.Buffer callocStack(int capacity)
```
Returns a new VkImageBlit.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

mallocStack
```
public static VkImageBlit.Buffer mallocStack(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

callocStack
```
public static VkImageBlit.Buffer callocStack(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.

Class VkImageBlit

Description

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

SRCOFFSETS

DSTSUBRESOURCE

DSTOFFSETS

Constructor Detail

VkImageBlit

Method Detail

sizeof

srcSubresource

srcOffsets

srcOffsets

dstSubresource

dstOffsets

dstOffsets

srcSubresource

srcSubresource

srcOffsets

srcOffsets

srcOffsets

srcOffsets

dstSubresource

dstSubresource

dstOffsets

dstOffsets

dstOffsets

dstOffsets

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsrcSubresource

nsrcOffsets

nsrcOffsets

ndstSubresource

ndstOffsets

ndstOffsets

nsrcSubresource

nsrcOffsets

nsrcOffsets

ndstSubresource

ndstOffsets

ndstOffsets