org.lwjgl.vulkan.VkImageToMemoryCopy

All Implemented Interfaces:: AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:: VkImageToMemoryCopyEXT

public class VkImageToMemoryCopy extends Struct<VkImageToMemoryCopy> implements NativeResource


 struct VkImageToMemoryCopy {
     VkStructureType sType;
     void const * pNext;
     void * 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

VkImageToMemoryCopy.Buffer

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

Modifier and Type

Field

Description

static final int

ALIGNOF

The struct alignment in bytes.

static final int

IMAGEEXTENT

The struct member offsets.

static final int

IMAGEOFFSET

The struct member offsets.

static final int

IMAGESUBRESOURCE

The struct member offsets.

static final int

MEMORYIMAGEHEIGHT

The struct member offsets.

static final int

MEMORYROWLENGTH

The struct member offsets.

static final int

PHOSTPOINTER

The struct member offsets.

static final int

PNEXT

The struct member offsets.

static final int

SIZEOF

The struct size in bytes.

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

VkImageToMemoryCopy(ByteBuffer container)

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

Modifier and Type

Method

Description

static VkImageToMemoryCopy

calloc()

Returns a new VkImageToMemoryCopy instance allocated with memCalloc.

static VkImageToMemoryCopy.Buffer

calloc(int capacity)

Returns a new VkImageToMemoryCopy.Buffer instance allocated with memCalloc.

static VkImageToMemoryCopy.Buffer

calloc(int capacity, MemoryStack stack)

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

static VkImageToMemoryCopy

calloc(MemoryStack stack)

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

static VkImageToMemoryCopy

create()

Returns a new VkImageToMemoryCopy instance allocated with BufferUtils.

static VkImageToMemoryCopy.Buffer

create(int capacity)

Returns a new VkImageToMemoryCopy.Buffer instance allocated with BufferUtils.

static VkImageToMemoryCopy

create(long address)

Returns a new VkImageToMemoryCopy instance for the specified memory address.

static VkImageToMemoryCopy.Buffer

create(long address, int capacity)

Create a VkImageToMemoryCopy.Buffer instance at the specified memory.

static @Nullable VkImageToMemoryCopy

createSafe(long address)

Like create, but returns null if address is NULL.

static @Nullable VkImageToMemoryCopy.Buffer

createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

VkExtent3D

imageExtent()

VkImageToMemoryCopy

imageExtent(Consumer<VkExtent3D> consumer)

Passes the imageExtent field to the specified Consumer.

VkImageToMemoryCopy

imageExtent(VkExtent3D value)

Copies the specified VkExtent3D to the imageExtent field.

VkOffset3D

imageOffset()

VkImageToMemoryCopy

imageOffset(Consumer<VkOffset3D> consumer)

Passes the imageOffset field to the specified Consumer.

VkImageToMemoryCopy

imageOffset(VkOffset3D value)

Copies the specified VkOffset3D to the imageOffset field.

VkImageSubresourceLayers

imageSubresource()

VkImageToMemoryCopy

imageSubresource(Consumer<VkImageSubresourceLayers> consumer)

Passes the imageSubresource field to the specified Consumer.

VkImageToMemoryCopy

imageSubresource(VkImageSubresourceLayers value)

Copies the specified VkImageSubresourceLayers to the imageSubresource field.

static VkImageToMemoryCopy

malloc()

Returns a new VkImageToMemoryCopy instance allocated with memAlloc.

static VkImageToMemoryCopy.Buffer

malloc(int capacity)

Returns a new VkImageToMemoryCopy.Buffer instance allocated with memAlloc.

static VkImageToMemoryCopy.Buffer

malloc(int capacity, MemoryStack stack)

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

static VkImageToMemoryCopy

malloc(MemoryStack stack)

Returns a new VkImageToMemoryCopy instance allocated on the specified MemoryStack.

int

memoryImageHeight()

VkImageToMemoryCopy

memoryImageHeight(int value)

Sets the specified value to the memoryImageHeight field.

int

memoryRowLength()

VkImageToMemoryCopy

memoryRowLength(int value)

Sets the specified value to the memoryRowLength field.

static VkExtent3D

nimageExtent(long struct)

Unsafe version of imageExtent().

static void

nimageExtent(long struct, VkExtent3D value)

Unsafe version of imageExtent.

static VkOffset3D

nimageOffset(long struct)

Unsafe version of imageOffset().

static void

nimageOffset(long struct, VkOffset3D value)

Unsafe version of imageOffset.

static VkImageSubresourceLayers

nimageSubresource(long struct)

Unsafe version of imageSubresource().

static void

nimageSubresource(long struct, VkImageSubresourceLayers value)

Unsafe version of imageSubresource.

static int

nmemoryImageHeight(long struct)

Unsafe version of memoryImageHeight().

static void

nmemoryImageHeight(long struct, int value)

Unsafe version of memoryImageHeight.

static int

nmemoryRowLength(long struct)

Unsafe version of memoryRowLength().

static void

nmemoryRowLength(long struct, int value)

Unsafe version of memoryRowLength.

static long

npHostPointer(long struct)

Unsafe version of pHostPointer().

static void

npHostPointer(long struct, long value)

Unsafe version of pHostPointer.

static long

npNext(long struct)

Unsafe version of pNext().

static void

npNext(long struct, long value)

Unsafe version of pNext.

static int

nsType(long struct)

Unsafe version of sType().

static void

nsType(long struct, int value)

Unsafe version of sType.

long

pHostPointer()

VkImageToMemoryCopy

pHostPointer(long value)

Sets the specified value to the pHostPointer field.

long

pNext()

VkImageToMemoryCopy

pNext(long value)

Sets the specified value to the pNext field.

VkImageToMemoryCopy

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

Initializes this struct with the specified values.

VkImageToMemoryCopy

set(VkImageToMemoryCopy src)

Copies the specified struct data to this struct.

int

sizeof()

Returns sizeof(struct).

int

sType()

VkImageToMemoryCopy

sType(int value)

Sets the specified value to the sType field.

VkImageToMemoryCopy

sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_TO_MEMORY_COPY value to the sType field.

static void

validate(long struct)

Validates pointer members that should not be NULL.

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.
- PHOSTPOINTER
  
  public static final int PHOSTPOINTER
  
  The struct member offsets.
- MEMORYROWLENGTH
  
  public static final int MEMORYROWLENGTH
  
  The struct member offsets.
- MEMORYIMAGEHEIGHT
  
  public static final int MEMORYIMAGEHEIGHT
  
  The struct member offsets.
- IMAGESUBRESOURCE
  
  public static final int IMAGESUBRESOURCE
  
  The struct member offsets.
- IMAGEOFFSET
  
  public static final int IMAGEOFFSET
  
  The struct member offsets.
- IMAGEEXTENT
  
  public static final int IMAGEEXTENT
  
  The struct member offsets.
Constructor Details
- VkImageToMemoryCopy
  
  public VkImageToMemoryCopy(ByteBuffer container)
  
  Creates a VkImageToMemoryCopy 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()
  
  Description copied from class: Struct
  
  Returns sizeof(struct).
  
  Specified by:
  
  sizeof in class Struct<VkImageToMemoryCopy>
- sType
  
  public int sType()
  
  Returns:
  
  the value of the sType field.
- pNext
  
  public long pNext()
  
  Returns:
  
  the value of the pNext field.
- pHostPointer
  
  public long pHostPointer()
  
  Returns:
  
  the value of the pHostPointer field.
- memoryRowLength
  
  public int memoryRowLength()
  
  Returns:
  
  the value of the memoryRowLength field.
- memoryImageHeight
  
  public int memoryImageHeight()
  
  Returns:
  
  the value of the memoryImageHeight field.
- imageSubresource
  
  public VkImageSubresourceLayers imageSubresource()
  
  Returns:
  
  a VkImageSubresourceLayers view of the imageSubresource field.
- imageOffset
  
  public VkOffset3D imageOffset()
  
  Returns:
  
  a VkOffset3D view of the imageOffset field.
- imageExtent
  
  public VkExtent3D imageExtent()
  
  Returns:
  
  a VkExtent3D view of the imageExtent field.
- sType
  
  public VkImageToMemoryCopy sType(int value)
  
  Sets the specified value to the sType field.
- sType$Default
  
  public VkImageToMemoryCopy sType$Default()
  
  Sets the STRUCTURE_TYPE_IMAGE_TO_MEMORY_COPY value to the sType field.
- pNext
  
  public VkImageToMemoryCopy pNext(long value)
  
  Sets the specified value to the pNext field.
- pHostPointer
  
  public VkImageToMemoryCopy pHostPointer(long value)
  
  Sets the specified value to the pHostPointer field.
- memoryRowLength
  
  public VkImageToMemoryCopy memoryRowLength(int value)
  
  Sets the specified value to the memoryRowLength field.
- memoryImageHeight
  
  public VkImageToMemoryCopy memoryImageHeight(int value)
  
  Sets the specified value to the memoryImageHeight field.
- imageSubresource
  
  public VkImageToMemoryCopy imageSubresource(VkImageSubresourceLayers value)
  
  Copies the specified VkImageSubresourceLayers to the imageSubresource field.
- imageSubresource
  
  public VkImageToMemoryCopy imageSubresource(Consumer<VkImageSubresourceLayers> consumer)
  
  Passes the imageSubresource field to the specified Consumer.
- imageOffset
  
  public VkImageToMemoryCopy imageOffset(VkOffset3D value)
  
  Copies the specified VkOffset3D to the imageOffset field.
- imageOffset
  
  public VkImageToMemoryCopy imageOffset(Consumer<VkOffset3D> consumer)
  
  Passes the imageOffset field to the specified Consumer.
- imageExtent
  
  public VkImageToMemoryCopy imageExtent(VkExtent3D value)
  
  Copies the specified VkExtent3D to the imageExtent field.
- imageExtent
  
  public VkImageToMemoryCopy imageExtent(Consumer<VkExtent3D> consumer)
  
  Passes the imageExtent field to the specified Consumer.
- set
  
  public VkImageToMemoryCopy set(int sType, long pNext, long pHostPointer, int memoryRowLength, int memoryImageHeight, VkImageSubresourceLayers imageSubresource, VkOffset3D imageOffset, VkExtent3D imageExtent)
  
  Initializes this struct with the specified values.
- set
  
  public VkImageToMemoryCopy set(VkImageToMemoryCopy src)
  
  Copies the specified struct data to this struct.
  
  Parameters:
  
  src - the source struct
  
  Returns:
  
  this struct
- malloc
  
  public static VkImageToMemoryCopy malloc()
  
  Returns a new VkImageToMemoryCopy instance allocated with memAlloc. The instance must be explicitly freed.
- calloc
  
  public static VkImageToMemoryCopy calloc()
  
  Returns a new VkImageToMemoryCopy instance allocated with memCalloc. The instance must be explicitly freed.
- create
  
  public static VkImageToMemoryCopy create()
  
  Returns a new VkImageToMemoryCopy instance allocated with BufferUtils.
- create
  
  public static VkImageToMemoryCopy create(long address)
  
  Returns a new VkImageToMemoryCopy instance for the specified memory address.
- createSafe
  
  public static @Nullable VkImageToMemoryCopy createSafe(long address)
  
  Like create, but returns null if address is NULL.
- malloc
  
  public static VkImageToMemoryCopy.Buffer malloc(int capacity)
  
  Returns a new VkImageToMemoryCopy.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- calloc
  
  public static VkImageToMemoryCopy.Buffer calloc(int capacity)
  
  Returns a new VkImageToMemoryCopy.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static VkImageToMemoryCopy.Buffer create(int capacity)
  
  Returns a new VkImageToMemoryCopy.Buffer instance allocated with BufferUtils.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static VkImageToMemoryCopy.Buffer create(long address, int capacity)
  
  Create a VkImageToMemoryCopy.Buffer instance at the specified memory.
  
  Parameters:
  
  address - the memory address
  
  capacity - the buffer capacity
- createSafe
  
  public static @Nullable VkImageToMemoryCopy.Buffer createSafe(long address, int capacity)
  
  Like create, but returns null if address is NULL.
- malloc
  
  public static VkImageToMemoryCopy malloc(MemoryStack stack)
  
  Returns a new VkImageToMemoryCopy instance allocated on the specified MemoryStack.
  
  Parameters:
  
  stack - the stack from which to allocate
- calloc
  
  public static VkImageToMemoryCopy calloc(MemoryStack stack)
  
  Returns a new VkImageToMemoryCopy instance allocated on the specified MemoryStack and initializes all its bits to zero.
  
  Parameters:
  
  stack - the stack from which to allocate
- malloc
  
  public static VkImageToMemoryCopy.Buffer malloc(int capacity, MemoryStack stack)
  
  Returns a new VkImageToMemoryCopy.Buffer instance allocated on the specified MemoryStack.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- calloc
  
  public static VkImageToMemoryCopy.Buffer calloc(int capacity, MemoryStack stack)
  
  Returns a new VkImageToMemoryCopy.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().
- npHostPointer
  
  public static long npHostPointer(long struct)
  
  Unsafe version of pHostPointer().
- nmemoryRowLength
  
  public static int nmemoryRowLength(long struct)
  
  Unsafe version of memoryRowLength().
- nmemoryImageHeight
  
  public static int nmemoryImageHeight(long struct)
  
  Unsafe version of memoryImageHeight().
- nimageSubresource
  
  public static VkImageSubresourceLayers nimageSubresource(long struct)
  
  Unsafe version of imageSubresource().
- nimageOffset
  
  public static VkOffset3D nimageOffset(long struct)
  
  Unsafe version of imageOffset().
- nimageExtent
  
  public static VkExtent3D nimageExtent(long struct)
  
  Unsafe version of imageExtent().
- 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.
- npHostPointer
  
  public static void npHostPointer(long struct, long value)
  
  Unsafe version of pHostPointer.
- nmemoryRowLength
  
  public static void nmemoryRowLength(long struct, int value)
  
  Unsafe version of memoryRowLength.
- nmemoryImageHeight
  
  public static void nmemoryImageHeight(long struct, int value)
  
  Unsafe version of memoryImageHeight.
- nimageSubresource
  
  public static void nimageSubresource(long struct, VkImageSubresourceLayers value)
  
  Unsafe version of imageSubresource.
- nimageOffset
  
  public static void nimageOffset(long struct, VkOffset3D value)
  
  Unsafe version of imageOffset.
- nimageExtent
  
  public static void nimageExtent(long struct, VkExtent3D value)
  
  Unsafe version of imageExtent.
- validate
  
  public static void validate(long struct)
  
  Validates pointer members that should not be NULL.
  
  Parameters:
  
  struct - the struct to validate

Class VkImageToMemoryCopy

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

PHOSTPOINTER

MEMORYROWLENGTH

MEMORYIMAGEHEIGHT

IMAGESUBRESOURCE

IMAGEOFFSET

IMAGEEXTENT

Constructor Details

VkImageToMemoryCopy

Method Details

sizeof

sType

pNext

pHostPointer

memoryRowLength

memoryImageHeight

imageSubresource

imageOffset

imageExtent

sType

sType$Default

pNext

pHostPointer

memoryRowLength

memoryImageHeight

imageSubresource

imageSubresource

imageOffset

imageOffset

imageExtent

imageExtent

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

nsType

npNext

npHostPointer

nmemoryRowLength

nmemoryImageHeight

nimageSubresource

nimageOffset

nimageExtent

nsType

npNext

npHostPointer

nmemoryRowLength

nmemoryImageHeight

nimageSubresource

nimageOffset

nimageExtent

validate