Package org.lwjgl.vulkan
Class VkSubresourceLayout
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkSubresourceLayout
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkSubresourceLayout extends Struct
Khronos Reference Page
Vulkan SpecificationContains information about the layout of an image subresource (mipLevel/arrayLayer) of an image created with linear tiling.
Member documentation
offset– the byte offset from the start of the image where the image subresource beginssize– the size in bytes of the image subresourcerowPitch– the number of bytes between each row of texels in an imagearrayPitch– the number of bytes between each array layer of an imagedepthPitch– the number of bytes between each slice of 3D image
Layout
struct VkSubresourceLayout { VkDeviceSize offset; VkDeviceSize size; VkDeviceSize rowPitch; VkDeviceSize arrayPitch; VkDeviceSize depthPitch; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classVkSubresourceLayout.BufferAn array ofVkSubresourceLayoutstructs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static intSIZEOFThe struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and Description VkSubresourceLayout(java.nio.ByteBuffer container)Creates aVkSubresourceLayoutinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description longarrayPitch()Returns the value of thearrayPitchfield.static VkSubresourceLayoutcalloc()Returns a newVkSubresourceLayoutinstance allocated withmemCalloc.static VkSubresourceLayout.Buffercalloc(int capacity)Returns a newVkSubresourceLayout.Bufferinstance allocated withmemCalloc.static VkSubresourceLayoutcallocStack()Returns a newVkSubresourceLayoutinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkSubresourceLayout.BuffercallocStack(int capacity)Returns a newVkSubresourceLayout.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkSubresourceLayout.BuffercallocStack(int capacity, MemoryStack stack)Returns a newVkSubresourceLayout.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkSubresourceLayoutcallocStack(MemoryStack stack)Returns a newVkSubresourceLayoutinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkSubresourceLayoutcreate()Returns a newVkSubresourceLayoutinstance allocated withBufferUtils.static VkSubresourceLayout.Buffercreate(int capacity)Returns a newVkSubresourceLayout.Bufferinstance allocated withBufferUtils.static VkSubresourceLayoutcreate(long address)Returns a newVkSubresourceLayoutinstance for the specified memory address ornullif the address isNULL.static VkSubresourceLayout.Buffercreate(long address, int capacity)Create aVkSubresourceLayout.Bufferinstance at the specified memory.longdepthPitch()Returns the value of thedepthPitchfield.static VkSubresourceLayoutmalloc()Returns a newVkSubresourceLayoutinstance allocated withmemAlloc.static VkSubresourceLayout.Buffermalloc(int capacity)Returns a newVkSubresourceLayout.Bufferinstance allocated withmemAlloc.static VkSubresourceLayoutmallocStack()Returns a newVkSubresourceLayoutinstance allocated on the thread-localMemoryStack.static VkSubresourceLayout.BuffermallocStack(int capacity)Returns a newVkSubresourceLayout.Bufferinstance allocated on the thread-localMemoryStack.static VkSubresourceLayout.BuffermallocStack(int capacity, MemoryStack stack)Returns a newVkSubresourceLayout.Bufferinstance allocated on the specifiedMemoryStack.static VkSubresourceLayoutmallocStack(MemoryStack stack)Returns a newVkSubresourceLayoutinstance allocated on the specifiedMemoryStack.longoffset()Returns the value of theoffsetfield.longrowPitch()Returns the value of therowPitchfield.longsize()Returns the value of thesizefield.intsizeof()Returns thesizeof(struct).-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkSubresourceLayout
public VkSubresourceLayout(java.nio.ByteBuffer container)
Creates aVkSubresourceLayoutinstance at the current position of the specifiedByteBuffercontainer. 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 Detail
-
sizeof
public int sizeof()
Description copied from class:StructReturns thesizeof(struct).
-
offset
public long offset()
Returns the value of theoffsetfield.
-
size
public long size()
Returns the value of thesizefield.
-
rowPitch
public long rowPitch()
Returns the value of therowPitchfield.
-
arrayPitch
public long arrayPitch()
Returns the value of thearrayPitchfield.
-
depthPitch
public long depthPitch()
Returns the value of thedepthPitchfield.
-
malloc
public static VkSubresourceLayout malloc()
Returns a newVkSubresourceLayoutinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkSubresourceLayout calloc()
Returns a newVkSubresourceLayoutinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkSubresourceLayout create()
Returns a newVkSubresourceLayoutinstance allocated withBufferUtils.
-
create
public static VkSubresourceLayout create(long address)
Returns a newVkSubresourceLayoutinstance for the specified memory address ornullif the address isNULL.
-
malloc
public static VkSubresourceLayout.Buffer malloc(int capacity)
Returns a newVkSubresourceLayout.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkSubresourceLayout.Buffer calloc(int capacity)
Returns a newVkSubresourceLayout.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkSubresourceLayout.Buffer create(int capacity)
Returns a newVkSubresourceLayout.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkSubresourceLayout.Buffer create(long address, int capacity)
Create aVkSubresourceLayout.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
mallocStack
public static VkSubresourceLayout mallocStack()
Returns a newVkSubresourceLayoutinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkSubresourceLayout callocStack()
Returns a newVkSubresourceLayoutinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkSubresourceLayout mallocStack(MemoryStack stack)
Returns a newVkSubresourceLayoutinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkSubresourceLayout callocStack(MemoryStack stack)
Returns a newVkSubresourceLayoutinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkSubresourceLayout.Buffer mallocStack(int capacity)
Returns a newVkSubresourceLayout.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkSubresourceLayout.Buffer callocStack(int capacity)
Returns a newVkSubresourceLayout.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkSubresourceLayout.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkSubresourceLayout.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkSubresourceLayout.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkSubresourceLayout.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
-