java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkImageBlit2>

org.lwjgl.vulkan.VkImageBlit2

All Implemented Interfaces:: AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

Direct Known Subclasses:: VkImageBlit2KHR

public class VkImageBlit2 extends org.lwjgl.system.Struct<VkImageBlit2> 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
If neither of the layerCount members of srcSubresource or dstSubresource are REMAINING_ARRAY_LAYERS, the layerCount members of srcSubresource or 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_BLIT_2
pNext must be NULL or a pointer to a valid instance of VkCopyCommandTransformInfoQCOM
The sType value of each struct in the pNext chain must be unique
srcSubresource must be a valid VkImageSubresourceLayers structure
dstSubresource must be a valid VkImageSubresourceLayers structure

Layout


 struct VkImageBlit2 {
     VkStructureType sType();
     void const * pNext();
     VkImageSubresourceLayers srcSubresource();
     VkOffset3D srcOffsets()[2];
     VkImageSubresourceLayers dstSubresource();
     VkOffset3D dstOffsets()[2];
 }

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

VkImageBlit2.Buffer

An array of VkImageBlit2 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

DSTOFFSETS

The struct member offsets.

static final int

DSTSUBRESOURCE

The struct member offsets.

static final int

PNEXT

The struct member offsets.

static final int

SIZEOF

The struct size in bytes.

static final int

SRCOFFSETS

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

VkImageBlit2(ByteBuffer container)

Creates a VkImageBlit2 instance at the current position of the specified ByteBuffer container.
Method Summary

Modifier and Type

Method

Description

static VkImageBlit2

calloc()

Returns a new VkImageBlit2 instance allocated with memCalloc.

static VkImageBlit2.Buffer

calloc(int capacity)

Returns a new VkImageBlit2.Buffer instance allocated with memCalloc.

static VkImageBlit2.Buffer

calloc(int capacity, org.lwjgl.system.MemoryStack stack)

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

static VkImageBlit2

calloc(org.lwjgl.system.MemoryStack stack)

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

static VkImageBlit2

create()

Returns a new VkImageBlit2 instance allocated with BufferUtils.

static VkImageBlit2.Buffer

create(int capacity)

Returns a new VkImageBlit2.Buffer instance allocated with BufferUtils.

static VkImageBlit2

create(long address)

Returns a new VkImageBlit2 instance for the specified memory address.

static VkImageBlit2.Buffer

create(long address, int capacity)

Create a VkImageBlit2.Buffer instance at the specified memory.

static @Nullable VkImageBlit2

createSafe(long address)

Like create, but returns null if address is NULL.

static @Nullable VkImageBlit2.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.

VkImageBlit2

dstOffsets(int index, Consumer<VkOffset3D> consumer)

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

VkImageBlit2

dstOffsets(int index, VkOffset3D value)

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

VkImageBlit2

dstOffsets(Consumer<VkOffset3D.Buffer> consumer)

Passes the dstOffsets() field to the specified Consumer.

VkImageBlit2

dstOffsets(VkOffset3D.Buffer value)

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

VkImageSubresourceLayers

dstSubresource()

the subresource to blit into.

VkImageBlit2

dstSubresource(Consumer<VkImageSubresourceLayers> consumer)

Passes the dstSubresource() field to the specified Consumer.

VkImageBlit2

dstSubresource(VkImageSubresourceLayers value)

Copies the specified VkImageSubresourceLayers to the dstSubresource() field.

static VkImageBlit2

malloc()

Returns a new VkImageBlit2 instance allocated with memAlloc.

static VkImageBlit2.Buffer

malloc(int capacity)

Returns a new VkImageBlit2.Buffer instance allocated with memAlloc.

static VkImageBlit2.Buffer

malloc(int capacity, org.lwjgl.system.MemoryStack stack)

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

static VkImageBlit2

malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkImageBlit2 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 long

npNext(long struct)

Unsafe version of pNext().

static void

npNext(long struct, long value)

Unsafe version of pNext.

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.

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.

VkImageBlit2

pNext(long value)

Sets the specified value to the pNext() field.

VkImageBlit2

pNext(VkCopyCommandTransformInfoQCOM value)

Prepends the specified VkCopyCommandTransformInfoQCOM value to the pNext chain.

VkImageBlit2

set(int sType, long pNext, VkImageSubresourceLayers srcSubresource, VkOffset3D.Buffer srcOffsets, VkImageSubresourceLayers dstSubresource, VkOffset3D.Buffer dstOffsets)

Initializes this struct with the specified values.

VkImageBlit2

set(VkImageBlit2 src)

Copies the specified struct data to this struct.

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.

VkImageBlit2

srcOffsets(int index, Consumer<VkOffset3D> consumer)

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

VkImageBlit2

srcOffsets(int index, VkOffset3D value)

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

VkImageBlit2

srcOffsets(Consumer<VkOffset3D.Buffer> consumer)

Passes the srcOffsets() field to the specified Consumer.

VkImageBlit2

srcOffsets(VkOffset3D.Buffer value)

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

VkImageSubresourceLayers

srcSubresource()

the subresource to blit from.

VkImageBlit2

srcSubresource(Consumer<VkImageSubresourceLayers> consumer)

Passes the srcSubresource() field to the specified Consumer.

VkImageBlit2

srcSubresource(VkImageSubresourceLayers value)

Copies the specified VkImageSubresourceLayers to the srcSubresource() field.

int

sType()

a VkStructureType value identifying this structure.

VkImageBlit2

sType(int value)

Sets the specified value to the sType() field.

VkImageBlit2

sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_BLIT_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.
- 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 Details
- VkImageBlit2
  
  public VkImageBlit2(ByteBuffer container)
  
  Creates a VkImageBlit2 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<VkImageBlit2>
- 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()
  
  the subresource to blit from.
- srcOffsets
  
  public VkOffset3D.Buffer srcOffsets()
  
  a pointer to an array of two VkOffset3D structures specifying the bounds of the source region within srcSubresource.
- 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()
  
  a pointer to an array of two VkOffset3D structures specifying the bounds of the destination region within dstSubresource.
- dstOffsets
  
  public VkOffset3D dstOffsets(int index)
  
  a pointer to an array of two VkOffset3D structures specifying the bounds of the destination region within dstSubresource.
- sType
  
  public VkImageBlit2 sType(int value)
  
  Sets the specified value to the sType() field.
- sType$Default
  
  public VkImageBlit2 sType$Default()
  
  Sets the STRUCTURE_TYPE_IMAGE_BLIT_2 value to the sType() field.
- pNext
  
  public VkImageBlit2 pNext(long value)
  
  Sets the specified value to the pNext() field.
- pNext
  
  public VkImageBlit2 pNext(VkCopyCommandTransformInfoQCOM value)
  
  Prepends the specified VkCopyCommandTransformInfoQCOM value to the pNext chain.
- srcSubresource
  
  public VkImageBlit2 srcSubresource(VkImageSubresourceLayers value)
  
  Copies the specified VkImageSubresourceLayers to the srcSubresource() field.
- srcSubresource
  
  public VkImageBlit2 srcSubresource(Consumer<VkImageSubresourceLayers> consumer)
  
  Passes the srcSubresource() field to the specified Consumer.
- srcOffsets
  
  public VkImageBlit2 srcOffsets(VkOffset3D.Buffer value)
  
  Copies the specified VkOffset3D.Buffer to the srcOffsets() field.
- srcOffsets
  
  public VkImageBlit2 srcOffsets(int index, VkOffset3D value)
  
  Copies the specified VkOffset3D at the specified index of the srcOffsets() field.
- srcOffsets
  
  public VkImageBlit2 srcOffsets(Consumer<VkOffset3D.Buffer> consumer)
  
  Passes the srcOffsets() field to the specified Consumer.
- srcOffsets
  
  public VkImageBlit2 srcOffsets(int index, Consumer<VkOffset3D> consumer)
  
  Passes the element at index of the srcOffsets() field to the specified Consumer.
- dstSubresource
  
  public VkImageBlit2 dstSubresource(VkImageSubresourceLayers value)
  
  Copies the specified VkImageSubresourceLayers to the dstSubresource() field.
- dstSubresource
  
  public VkImageBlit2 dstSubresource(Consumer<VkImageSubresourceLayers> consumer)
  
  Passes the dstSubresource() field to the specified Consumer.
- dstOffsets
  
  public VkImageBlit2 dstOffsets(VkOffset3D.Buffer value)
  
  Copies the specified VkOffset3D.Buffer to the dstOffsets() field.
- dstOffsets
  
  public VkImageBlit2 dstOffsets(int index, VkOffset3D value)
  
  Copies the specified VkOffset3D at the specified index of the dstOffsets() field.
- dstOffsets
  
  public VkImageBlit2 dstOffsets(Consumer<VkOffset3D.Buffer> consumer)
  
  Passes the dstOffsets() field to the specified Consumer.
- dstOffsets
  
  public VkImageBlit2 dstOffsets(int index, Consumer<VkOffset3D> consumer)
  
  Passes the element at index of the dstOffsets() field to the specified Consumer.
- set
  
  public VkImageBlit2 set(int sType, long pNext, VkImageSubresourceLayers srcSubresource, VkOffset3D.Buffer srcOffsets, VkImageSubresourceLayers dstSubresource, VkOffset3D.Buffer dstOffsets)
  
  Initializes this struct with the specified values.
- set
  
  public VkImageBlit2 set(VkImageBlit2 src)
  
  Copies the specified struct data to this struct.
  
  Parameters:
  
  src - the source struct
  
  Returns:
  
  this struct
- malloc
  
  public static VkImageBlit2 malloc()
  
  Returns a new VkImageBlit2 instance allocated with memAlloc. The instance must be explicitly freed.
- calloc
  
  public static VkImageBlit2 calloc()
  
  Returns a new VkImageBlit2 instance allocated with memCalloc. The instance must be explicitly freed.
- create
  
  public static VkImageBlit2 create()
  
  Returns a new VkImageBlit2 instance allocated with BufferUtils.
- create
  
  public static VkImageBlit2 create(long address)
  
  Returns a new VkImageBlit2 instance for the specified memory address.
- createSafe
  
  public static @Nullable VkImageBlit2 createSafe(long address)
  
  Like create, but returns null if address is NULL.
- malloc
  
  public static VkImageBlit2.Buffer malloc(int capacity)
  
  Returns a new VkImageBlit2.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- calloc
  
  public static VkImageBlit2.Buffer calloc(int capacity)
  
  Returns a new VkImageBlit2.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static VkImageBlit2.Buffer create(int capacity)
  
  Returns a new VkImageBlit2.Buffer instance allocated with BufferUtils.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static VkImageBlit2.Buffer create(long address, int capacity)
  
  Create a VkImageBlit2.Buffer instance at the specified memory.
  
  Parameters:
  
  address - the memory address
  
  capacity - the buffer capacity
- createSafe
  
  public static @Nullable VkImageBlit2.Buffer createSafe(long address, int capacity)
  
  Like create, but returns null if address is NULL.
- malloc
  
  public static VkImageBlit2 malloc(org.lwjgl.system.MemoryStack stack)
  
  Returns a new VkImageBlit2 instance allocated on the specified MemoryStack.
  
  Parameters:
  
  stack - the stack from which to allocate
- calloc
  
  public static VkImageBlit2 calloc(org.lwjgl.system.MemoryStack stack)
  
  Returns a new VkImageBlit2 instance allocated on the specified MemoryStack and initializes all its bits to zero.
  
  Parameters:
  
  stack - the stack from which to allocate
- malloc
  
  public static VkImageBlit2.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
  
  Returns a new VkImageBlit2.Buffer instance allocated on the specified MemoryStack.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- calloc
  
  public static VkImageBlit2.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
  
  Returns a new VkImageBlit2.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().
- 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.
- 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.
- 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 VkImageBlit2

Description

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested Class Summary

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

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 Details

SIZEOF

ALIGNOF

STYPE

PNEXT

SRCSUBRESOURCE

SRCOFFSETS

DSTSUBRESOURCE

DSTOFFSETS

Constructor Details

VkImageBlit2

Method Details

sizeof

sType

pNext

srcSubresource

srcOffsets

srcOffsets

dstSubresource

dstOffsets

dstOffsets

sType

sType$Default

pNext

pNext

srcSubresource

srcSubresource

srcOffsets

srcOffsets

srcOffsets

srcOffsets

dstSubresource

dstSubresource

dstOffsets

dstOffsets

dstOffsets

dstOffsets

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

nsType

npNext

nsrcSubresource

nsrcOffsets

nsrcOffsets

ndstSubresource

ndstOffsets

ndstOffsets

nsType

npNext