Package org.lwjgl.vulkan

Class VkMemoryToImageCopyEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkMemoryToImageCopy>

org.lwjgl.vulkan.VkMemoryToImageCopy

org.lwjgl.vulkan.VkMemoryToImageCopyEXT

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkMemoryToImageCopyEXT
extends VkMemoryToImageCopy

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkMemoryToImageCopyEXT.Buffer	An array of VkMemoryToImageCopyEXT structs.

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

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields inherited from class org.lwjgl.vulkan.VkMemoryToImageCopy

ALIGNOF, IMAGEEXTENT, IMAGEOFFSET, IMAGESUBRESOURCE, MEMORYIMAGEHEIGHT, MEMORYROWLENGTH, PHOSTPOINTER, PNEXT, SIZEOF, STYPE

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkMemoryToImageCopyEXT(ByteBuffer container)	Creates a VkMemoryToImageCopyEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkMemoryToImageCopyEXT	calloc()	Returns a new VkMemoryToImageCopyEXT instance allocated with memCalloc.
static VkMemoryToImageCopyEXT.Buffer	calloc(int capacity)	Returns a new VkMemoryToImageCopyEXT.Buffer instance allocated with memCalloc.
static VkMemoryToImageCopyEXT.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkMemoryToImageCopyEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkMemoryToImageCopyEXT	calloc(MemoryStack stack)	Returns a new VkMemoryToImageCopyEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkMemoryToImageCopyEXT	create()	Returns a new VkMemoryToImageCopyEXT instance allocated with BufferUtils.
static VkMemoryToImageCopyEXT.Buffer	create(int capacity)	Returns a new VkMemoryToImageCopyEXT.Buffer instance allocated with BufferUtils.
static VkMemoryToImageCopyEXT	create(long address)	Returns a new VkMemoryToImageCopyEXT instance for the specified memory address.
static VkMemoryToImageCopyEXT.Buffer	create(long address, int capacity)	Create a VkMemoryToImageCopyEXT.Buffer instance at the specified memory.
static @Nullable VkMemoryToImageCopyEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkMemoryToImageCopyEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkMemoryToImageCopyEXT	imageExtent(Consumer<VkExtent3D> consumer)	Passes the imageExtent field to the specified Consumer.
VkMemoryToImageCopyEXT	imageExtent(VkExtent3D value)	Copies the specified VkExtent3D to the imageExtent field.
VkMemoryToImageCopyEXT	imageOffset(Consumer<VkOffset3D> consumer)	Passes the imageOffset field to the specified Consumer.
VkMemoryToImageCopyEXT	imageOffset(VkOffset3D value)	Copies the specified VkOffset3D to the imageOffset field.
VkMemoryToImageCopyEXT	imageSubresource(Consumer<VkImageSubresourceLayers> consumer)	Passes the imageSubresource field to the specified Consumer.
VkMemoryToImageCopyEXT	imageSubresource(VkImageSubresourceLayers value)	Copies the specified VkImageSubresourceLayers to the imageSubresource field.
static VkMemoryToImageCopyEXT	malloc()	Returns a new VkMemoryToImageCopyEXT instance allocated with memAlloc.
static VkMemoryToImageCopyEXT.Buffer	malloc(int capacity)	Returns a new VkMemoryToImageCopyEXT.Buffer instance allocated with memAlloc.
static VkMemoryToImageCopyEXT.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkMemoryToImageCopyEXT.Buffer instance allocated on the specified MemoryStack.
static VkMemoryToImageCopyEXT	malloc(MemoryStack stack)	Returns a new VkMemoryToImageCopyEXT instance allocated on the specified MemoryStack.
VkMemoryToImageCopyEXT	memoryImageHeight(int value)	Sets the specified value to the memoryImageHeight field.
VkMemoryToImageCopyEXT	memoryRowLength(int value)	Sets the specified value to the memoryRowLength field.
VkMemoryToImageCopyEXT	pHostPointer(long value)	Sets the specified value to the pHostPointer field.
VkMemoryToImageCopyEXT	pNext(long value)	Sets the specified value to the pNext field.
VkMemoryToImageCopyEXT	set(int sType, long pNext, long pHostPointer, int memoryRowLength, int memoryImageHeight, VkImageSubresourceLayers imageSubresource, VkOffset3D imageOffset, VkExtent3D imageExtent)	Initializes this struct with the specified values.
VkMemoryToImageCopyEXT	set(VkMemoryToImageCopyEXT src)	Copies the specified struct data to this struct.
VkMemoryToImageCopyEXT	sType(int value)	Sets the specified value to the sType field.
VkMemoryToImageCopyEXT	sType$Default()	Sets the STRUCTURE_TYPE_MEMORY_TO_IMAGE_COPY value to the sType field.

Methods inherited from class org.lwjgl.vulkan.VkMemoryToImageCopy

imageExtent, imageOffset, imageSubresource, memoryImageHeight, memoryRowLength, nimageExtent, nimageExtent, nimageOffset, nimageOffset, nimageSubresource, nimageSubresource, nmemoryImageHeight, nmemoryImageHeight, nmemoryRowLength, nmemoryRowLength, npHostPointer, npHostPointer, npNext, npNext, nsType, nsType, pHostPointer, pNext, set, sizeof, sType, validate

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

Constructor Details

VkMemoryToImageCopyEXT

public VkMemoryToImageCopyEXT(ByteBuffer container)

Creates a VkMemoryToImageCopyEXT 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

sType

public VkMemoryToImageCopyEXT sType(int value)

Sets the specified value to the sType field.

Overrides:

sType in class VkMemoryToImageCopy

sType$Default

public VkMemoryToImageCopyEXT sType$Default()

Sets the STRUCTURE_TYPE_MEMORY_TO_IMAGE_COPY value to the sType field.

Overrides:

sType$Default in class VkMemoryToImageCopy

pNext

public VkMemoryToImageCopyEXT pNext(long value)

Sets the specified value to the pNext field.

Overrides:

pNext in class VkMemoryToImageCopy

pHostPointer

public VkMemoryToImageCopyEXT pHostPointer(long value)

Sets the specified value to the pHostPointer field.

Overrides:

pHostPointer in class VkMemoryToImageCopy

memoryRowLength

public VkMemoryToImageCopyEXT memoryRowLength(int value)

Sets the specified value to the memoryRowLength field.

Overrides:

memoryRowLength in class VkMemoryToImageCopy

memoryImageHeight

public VkMemoryToImageCopyEXT memoryImageHeight(int value)

Sets the specified value to the memoryImageHeight field.

Overrides:

memoryImageHeight in class VkMemoryToImageCopy

imageSubresource

public VkMemoryToImageCopyEXT imageSubresource(VkImageSubresourceLayers value)

Copies the specified VkImageSubresourceLayers to the imageSubresource field.

Overrides:

imageSubresource in class VkMemoryToImageCopy

imageSubresource

public VkMemoryToImageCopyEXT imageSubresource(Consumer<VkImageSubresourceLayers> consumer)

Passes the imageSubresource field to the specified Consumer.

Overrides:

imageSubresource in class VkMemoryToImageCopy

imageOffset

public VkMemoryToImageCopyEXT imageOffset(VkOffset3D value)

Copies the specified VkOffset3D to the imageOffset field.

Overrides:

imageOffset in class VkMemoryToImageCopy

imageOffset

public VkMemoryToImageCopyEXT imageOffset(Consumer<VkOffset3D> consumer)

Passes the imageOffset field to the specified Consumer.

Overrides:

imageOffset in class VkMemoryToImageCopy

imageExtent

public VkMemoryToImageCopyEXT imageExtent(VkExtent3D value)

Copies the specified VkExtent3D to the imageExtent field.

Overrides:

imageExtent in class VkMemoryToImageCopy

imageExtent

public VkMemoryToImageCopyEXT imageExtent(Consumer<VkExtent3D> consumer)

Passes the imageExtent field to the specified Consumer.

Overrides:

imageExtent in class VkMemoryToImageCopy

set

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

Initializes this struct with the specified values.

Overrides:

set in class VkMemoryToImageCopy

set

public VkMemoryToImageCopyEXT set(VkMemoryToImageCopyEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkMemoryToImageCopyEXT malloc()

Returns a new VkMemoryToImageCopyEXT instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkMemoryToImageCopyEXT calloc()

Returns a new VkMemoryToImageCopyEXT instance allocated with memCalloc. The instance must be explicitly freed.

create

public static VkMemoryToImageCopyEXT create()

Returns a new VkMemoryToImageCopyEXT instance allocated with BufferUtils.

create

public static VkMemoryToImageCopyEXT create(long address)

Returns a new VkMemoryToImageCopyEXT instance for the specified memory address.

createSafe

public static @Nullable VkMemoryToImageCopyEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkMemoryToImageCopyEXT.Buffer malloc(int capacity)

Returns a new VkMemoryToImageCopyEXT.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkMemoryToImageCopyEXT.Buffer calloc(int capacity)

Returns a new VkMemoryToImageCopyEXT.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkMemoryToImageCopyEXT.Buffer create(int capacity)

Returns a new VkMemoryToImageCopyEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkMemoryToImageCopyEXT.Buffer create(long address,
 int capacity)

Create a VkMemoryToImageCopyEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkMemoryToImageCopyEXT.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static VkMemoryToImageCopyEXT malloc(MemoryStack stack)

Returns a new VkMemoryToImageCopyEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkMemoryToImageCopyEXT calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkMemoryToImageCopyEXT.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkMemoryToImageCopyEXT.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new VkMemoryToImageCopyEXT.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