LWJGL 3.3.3 · org.lwjgl.vulkan.VkImageBlit

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 the maintenance5 feature is not enabled, the layerCount member of srcSubresource or dstSubresource must not be REMAINING_ARRAY_LAYERS
If neither of the layerCount members of srcSubresource or dstSubresource are REMAINING_ARRAY_LAYERS, the layerCount members 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

Layout


struct VkImageBlit {
    VkImageSubresourceLayers srcSubresource;
    VkOffset3D srcOffsets[2];
    VkImageSubresourceLayers dstSubresource;
    VkOffset3D dstOffsets[2];
}

Modifier and Type	Class and Description
public static class	VkImageBlit.Buffer An array of `VkImageBlit` structs.

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	DSTOFFSETS The struct member offsets.
public static final int	DSTSUBRESOURCE The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	SRCOFFSETS The struct member offsets.
public static final int	SRCSUBRESOURCE The struct member offsets.

Access	Constructor and Description
protected	VkImageBlit(long address, ByteBuffer container)
public	VkImageBlit(ByteBuffer container) Creates a `VkImageBlit` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static VkImageBlit	calloc() Returns a new `VkImageBlit` instance allocated with `memCalloc`.
public static VkImageBlit.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkImageBlit.Buffer` instance allocated with `memCalloc`.
public static VkImageBlit	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkImageBlit` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkImageBlit.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkImageBlit.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkImageBlit	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkImageBlit	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkImageBlit.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkImageBlit.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkImageBlit	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Implements abstract org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public static VkImageBlit	create() Returns a new `VkImageBlit` instance allocated with `BufferUtils`.
public static VkImageBlit	create(long address) Returns a new `VkImageBlit` instance for the specified memory address.
public static VkImageBlit.Buffer	create(int the buffer capacity capacity) Returns a new `VkImageBlit.Buffer` instance allocated with `BufferUtils`.
public static VkImageBlit.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkImageBlit.Buffer` instance at the specified memory.
public static VkImageBlit	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkImageBlit.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public VkOffset3D.Buffer	dstOffsets() a pointer to an array of two `VkOffset3D` structures specifying the bounds of the destination region within `dstSubresource`.
public VkOffset3D	dstOffsets(int index) a pointer to an array of two `VkOffset3D` structures specifying the bounds of the destination region within `dstSubresource`.
public VkImageBlit	dstOffsets(VkOffset3D.Buffer value) Copies the specified `VkOffset3D.Buffer` to the `dstOffsets` field.
public VkImageBlit	dstOffsets(int index, VkOffset3D value) Copies the specified `VkOffset3D` at the specified index of the `dstOffsets` field.
public VkImageBlit	dstOffsets(Consumer<VkOffset3D.Buffer> consumer) Passes the `dstOffsets` field to the specified `Consumer`.
public VkImageBlit	dstOffsets(int index, Consumer<VkOffset3D> consumer) Passes the element at `index` of the `dstOffsets` field to the specified `Consumer`.
public VkImageSubresourceLayers	dstSubresource() the subresource to blit into.
public VkImageBlit	dstSubresource(VkImageSubresourceLayers value) Copies the specified `VkImageSubresourceLayers` to the `dstSubresource` field.
public VkImageBlit	dstSubresource(Consumer<VkImageSubresourceLayers> consumer) Passes the `dstSubresource` field to the specified `Consumer`.
public static VkImageBlit	malloc() Returns a new `VkImageBlit` instance allocated with `memAlloc`.
public static VkImageBlit.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkImageBlit.Buffer` instance allocated with `memAlloc`.
public static VkImageBlit	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkImageBlit` instance allocated on the specified `MemoryStack`.
public static VkImageBlit.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkImageBlit.Buffer` instance allocated on the specified `MemoryStack`.
public static VkImageBlit	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkImageBlit	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkImageBlit.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkImageBlit.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkOffset3D.Buffer	ndstOffsets(long struct) Unsafe version of `dstOffsets`.
public static VkOffset3D	ndstOffsets(long struct, int index) Unsafe version of `dstOffsets`.
public static void	ndstOffsets(long struct, VkOffset3D.Buffer value) Unsafe version of `dstOffsets`.
public static void	ndstOffsets(long struct, int index, VkOffset3D value) Unsafe version of `dstOffsets`.
public static VkImageSubresourceLayers	ndstSubresource(long struct) Unsafe version of `dstSubresource`.
public static void	ndstSubresource(long struct, VkImageSubresourceLayers value) Unsafe version of `dstSubresource`.
public static VkOffset3D.Buffer	nsrcOffsets(long struct) Unsafe version of `srcOffsets`.
public static VkOffset3D	nsrcOffsets(long struct, int index) Unsafe version of `srcOffsets`.
public static void	nsrcOffsets(long struct, VkOffset3D.Buffer value) Unsafe version of `srcOffsets`.
public static void	nsrcOffsets(long struct, int index, VkOffset3D value) Unsafe version of `srcOffsets`.
public static VkImageSubresourceLayers	nsrcSubresource(long struct) Unsafe version of `srcSubresource`.
public static void	nsrcSubresource(long struct, VkImageSubresourceLayers value) Unsafe version of `srcSubresource`.
public VkImageBlit	set(VkImageSubresourceLayers srcSubresource, VkOffset3D.Buffer srcOffsets, VkImageSubresourceLayers dstSubresource, VkOffset3D.Buffer dstOffsets) Initializes this struct with the specified values.
public VkImageBlit	Returns: this struct set(VkImageBlit the source struct src) Copies the specified struct data to this struct.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public VkOffset3D.Buffer	srcOffsets() a pointer to an array of two `VkOffset3D` structures specifying the bounds of the source region within `srcSubresource`.
public VkOffset3D	srcOffsets(int index) a pointer to an array of two `VkOffset3D` structures specifying the bounds of the source region within `srcSubresource`.
public VkImageBlit	srcOffsets(VkOffset3D.Buffer value) Copies the specified `VkOffset3D.Buffer` to the `srcOffsets` field.
public VkImageBlit	srcOffsets(int index, VkOffset3D value) Copies the specified `VkOffset3D` at the specified index of the `srcOffsets` field.
public VkImageBlit	srcOffsets(Consumer<VkOffset3D.Buffer> consumer) Passes the `srcOffsets` field to the specified `Consumer`.
public VkImageBlit	srcOffsets(int index, Consumer<VkOffset3D> consumer) Passes the element at `index` of the `srcOffsets` field to the specified `Consumer`.
public VkImageSubresourceLayers	srcSubresource() the subresource to blit from.
public VkImageBlit	srcSubresource(VkImageSubresourceLayers value) Copies the specified `VkImageSubresourceLayers` to the `srcSubresource` field.
public VkImageBlit	srcSubresource(Consumer<VkImageSubresourceLayers> consumer) Passes the `srcSubresource` field to the specified `Consumer`.

public Class VkImageBlit

Description

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary