Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkImageToMemoryCopyEXT

extends Struct<VkImageToMemoryCopyEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Structure specifying an image to host memory copy operation.
Description

This structure is functionally similar to VkBufferImageCopy2, except it defines host memory as the target of copy instead of a buffer. In particular, the same data packing rules and restrictions as that structure apply here as well.

Valid Usage
Valid Usage (Implicit)
See Also

VkCopyImageToMemoryInfoEXT, VkExtent3D, VkImageSubresourceLayers, VkOffset3D

Layout


struct VkImageToMemoryCopyEXT {
    VkStructureType sType;
    void const * pNext;
    void * pHostPointer;
    uint32_t memoryRowLength;
    uint32_t memoryImageHeight;
    VkImageSubresourceLayers imageSubresource;
    VkOffset3D imageOffset;
    VkExtent3D imageExtent;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkImageToMemoryCopyEXT.Buffer

An array of VkImageToMemoryCopyEXT structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

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
MEMORYIMAGEHEIGHT

The struct member offsets.

public static final int
MEMORYROWLENGTH

The struct member offsets.

public static final int
PHOSTPOINTER

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
VkImageToMemoryCopyEXT(long address, ByteBuffer container)

public
VkImageToMemoryCopyEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkImageToMemoryCopyEXT
calloc()

Returns a new VkImageToMemoryCopyEXT instance allocated with memCalloc.

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

Returns a new VkImageToMemoryCopyEXT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkImageToMemoryCopyEXT instance allocated with BufferUtils.

public static VkImageToMemoryCopyEXT
create(long address)

Returns a new VkImageToMemoryCopyEXT instance for the specified memory address.

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

Returns a new VkImageToMemoryCopyEXT.Buffer instance allocated with BufferUtils.

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

Create a VkImageToMemoryCopyEXT.Buffer instance at the specified memory.

public static VkImageToMemoryCopyEXT
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkImageToMemoryCopyEXT.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 VkImageToMemoryCopyEXT
imageExtent(VkExtent3D value)

Copies the specified VkExtent3D to the imageExtent field.

public VkImageToMemoryCopyEXT
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 image data.

public VkImageToMemoryCopyEXT
imageOffset(VkOffset3D value)

Copies the specified VkOffset3D to the imageOffset field.

public VkImageToMemoryCopyEXT
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 VkImageToMemoryCopyEXT
imageSubresource(VkImageSubresourceLayers value)

Copies the specified VkImageSubresourceLayers to the imageSubresource field.

public VkImageToMemoryCopyEXT
imageSubresource(Consumer<VkImageSubresourceLayers> consumer)

Passes the imageSubresource field to the specified Consumer.

public static VkImageToMemoryCopyEXT
malloc()

Returns a new VkImageToMemoryCopyEXT instance allocated with memAlloc.

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

Returns a new VkImageToMemoryCopyEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkImageToMemoryCopyEXT instance allocated on the specified MemoryStack.

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

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

public int
memoryImageHeight()

see memoryRowLength

public VkImageToMemoryCopyEXT
memoryImageHeight(int value)

Sets the specified value to the memoryImageHeight field.

public int
memoryRowLength()

memoryRowLength and memoryImageHeight specify in texels a subregion of a larger two- or three-dimensional image in host memory, and control the addressing calculations.

public VkImageToMemoryCopyEXT
memoryRowLength(int value)

Sets the specified value to the memoryRowLength field.

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 int
nmemoryImageHeight(long struct)

Unsafe version of memoryImageHeight.

public static void
nmemoryImageHeight(long struct, int value)

Unsafe version of memoryImageHeight.

public static int
nmemoryRowLength(long struct)

Unsafe version of memoryRowLength.

public static void
nmemoryRowLength(long struct, int value)

Unsafe version of memoryRowLength.

public static long
npHostPointer(long struct)

Unsafe version of pHostPointer.

public static void
npHostPointer(long struct, long value)

Unsafe version of pHostPointer.

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
pHostPointer()

the host memory address which is the destination of the copy.

public VkImageToMemoryCopyEXT
pHostPointer(long value)

Sets the specified value to the pHostPointer field.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkImageToMemoryCopyEXT
pNext(long value)

Sets the specified value to the pNext field.

public VkImageToMemoryCopyEXT
set(int sType, long pNext, long pHostPointer, int memoryRowLength, int memoryImageHeight, VkImageSubresourceLayers imageSubresource, VkOffset3D imageOffset, VkExtent3D imageExtent)

Initializes this struct with the specified values.

public VkImageToMemoryCopyEXT

Returns:

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

Sets the specified value to the sType field.

public VkImageToMemoryCopyEXT
sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_TO_MEMORY_COPY_EXT value to the sType field.

public static void
validate(long
the struct to validate
struct)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate