Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkBufferImageCopy2

extends Struct<VkBufferImageCopy2>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkBufferImageCopy2KHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Structure specifying a buffer image copy operation.
Description

This structure is functionally identical to VkBufferImageCopy, but adds sType and pNext parameters, allowing it to be more easily extended.

Valid Usage
Valid Usage (Implicit)
See Also

VkCopyBufferToImageInfo2, VkCopyImageToBufferInfo2, VkExtent3D, VkImageSubresourceLayers, VkOffset3D

Layout


struct VkBufferImageCopy2 {
    VkStructureType sType;
    void const * pNext;
    VkDeviceSize bufferOffset;
    uint32_t bufferRowLength;
    uint32_t bufferImageHeight;
    VkImageSubresourceLayers imageSubresource;
    VkOffset3D imageOffset;
    VkExtent3D imageExtent;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkBufferImageCopy2.Buffer

An array of VkBufferImageCopy2 structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
BUFFERIMAGEHEIGHT

The struct member offsets.

public static final int
BUFFEROFFSET

The struct member offsets.

public static final int
BUFFERROWLENGTH

The struct member offsets.

public static final int
IMAGEEXTENT

The struct member offsets.

public static final int
IMAGEOFFSET

The struct member offsets.

public static final int
IMAGESUBRESOURCE

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkBufferImageCopy2(long address, ByteBuffer container)

public
VkBufferImageCopy2(ByteBuffer container)

Creates a VkBufferImageCopy2 instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public int
bufferImageHeight()

see bufferRowLength

public VkBufferImageCopy2
bufferImageHeight(int value)

Sets the specified value to the bufferImageHeight field.

public long
bufferOffset()

the offset in bytes from the start of the buffer object where the image data is copied from or to.

public VkBufferImageCopy2
bufferOffset(long value)

Sets the specified value to the bufferOffset field.

public int
bufferRowLength()

bufferRowLength and bufferImageHeight specify in texels a subregion of a larger two- or three-dimensional image in buffer memory, and control the addressing calculations.

public VkBufferImageCopy2
bufferRowLength(int value)

Sets the specified value to the bufferRowLength field.

public static VkBufferImageCopy2
calloc()

Returns a new VkBufferImageCopy2 instance allocated with memCalloc.

public static VkBufferImageCopy2.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new VkBufferImageCopy2.Buffer instance allocated with memCalloc.

public static VkBufferImageCopy2
calloc(MemoryStack
the stack from which to allocate
stack)

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

public static VkBufferImageCopy2.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

protected VkBufferImageCopy2
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 VkBufferImageCopy2
create()

Returns a new VkBufferImageCopy2 instance allocated with BufferUtils.

public static VkBufferImageCopy2
create(long address)

Returns a new VkBufferImageCopy2 instance for the specified memory address.

public static VkBufferImageCopy2.Buffer
create(int
the buffer capacity
capacity)

Returns a new VkBufferImageCopy2.Buffer instance allocated with BufferUtils.

public static VkBufferImageCopy2.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Create a VkBufferImageCopy2.Buffer instance at the specified memory.

public static VkBufferImageCopy2
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkBufferImageCopy2.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public VkExtent3D
imageExtent()

the size in texels of the image to copy in width, height and depth.

public VkBufferImageCopy2
imageExtent(VkExtent3D value)

Copies the specified VkExtent3D to the imageExtent field.

public VkBufferImageCopy2
imageExtent(Consumer<VkExtent3D> consumer)

Passes the imageExtent field to the specified Consumer.

public VkOffset3D
imageOffset()

selects the initial x, y, z offsets in texels of the sub-region of the source or destination image data.

public VkBufferImageCopy2
imageOffset(VkOffset3D value)

Copies the specified VkOffset3D to the imageOffset field.

public VkBufferImageCopy2
imageOffset(Consumer<VkOffset3D> consumer)

Passes the imageOffset field to the specified Consumer.

public VkImageSubresourceLayers
imageSubresource()

a VkImageSubresourceLayers used to specify the specific image subresources of the image used for the source or destination image data.

public VkBufferImageCopy2
imageSubresource(VkImageSubresourceLayers value)

Copies the specified VkImageSubresourceLayers to the imageSubresource field.

public VkBufferImageCopy2
imageSubresource(Consumer<VkImageSubresourceLayers> consumer)

Passes the imageSubresource field to the specified Consumer.

public static VkBufferImageCopy2
malloc()

Returns a new VkBufferImageCopy2 instance allocated with memAlloc.

public static VkBufferImageCopy2.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new VkBufferImageCopy2.Buffer instance allocated with memAlloc.

public static VkBufferImageCopy2
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkBufferImageCopy2 instance allocated on the specified MemoryStack.

public static VkBufferImageCopy2.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static int
nbufferImageHeight(long struct)

Unsafe version of bufferImageHeight.

public static void
nbufferImageHeight(long struct, int value)

Unsafe version of bufferImageHeight.

public static long
nbufferOffset(long struct)

Unsafe version of bufferOffset.

public static void
nbufferOffset(long struct, long value)

Unsafe version of bufferOffset.

public static int
nbufferRowLength(long struct)

Unsafe version of bufferRowLength.

public static void
nbufferRowLength(long struct, int value)

Unsafe version of bufferRowLength.

public static VkExtent3D
nimageExtent(long struct)

Unsafe version of imageExtent.

public static void
nimageExtent(long struct, VkExtent3D value)

Unsafe version of imageExtent.

public static VkOffset3D
nimageOffset(long struct)

Unsafe version of imageOffset.

public static void
nimageOffset(long struct, VkOffset3D value)

Unsafe version of imageOffset.

public static VkImageSubresourceLayers
nimageSubresource(long struct)

Unsafe version of imageSubresource.

public static void
nimageSubresource(long struct, VkImageSubresourceLayers value)

Unsafe version of imageSubresource.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkBufferImageCopy2
pNext(long value)

Sets the specified value to the pNext field.

public VkBufferImageCopy2
pNext(VkCopyCommandTransformInfoQCOM value)

Prepends the specified VkCopyCommandTransformInfoQCOM value to the pNext chain.

public VkBufferImageCopy2
set(int sType, long pNext, long bufferOffset, int bufferRowLength, int bufferImageHeight, VkImageSubresourceLayers imageSubresource, VkOffset3D imageOffset, VkExtent3D imageExtent)

Initializes this struct with the specified values.

public VkBufferImageCopy2

Returns:

this struct
set(VkBufferImageCopy2
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 int
sType()

a VkStructureType value identifying this structure.

public VkBufferImageCopy2
sType(int value)

Sets the specified value to the sType field.

public VkBufferImageCopy2
sType$Default()

Sets the STRUCTURE_TYPE_BUFFER_IMAGE_COPY_2 value to the sType field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate