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 class
VkSubresourceLayout.Buffer
An array ofVkSubresourceLayout
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The 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 aVkSubresourceLayout
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description long
arrayPitch()
Returns the value of thearrayPitch
field.static VkSubresourceLayout
calloc()
Returns a newVkSubresourceLayout
instance allocated withmemCalloc
.static VkSubresourceLayout.Buffer
calloc(int capacity)
Returns a newVkSubresourceLayout.Buffer
instance allocated withmemCalloc
.static VkSubresourceLayout
callocStack()
Returns a newVkSubresourceLayout
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkSubresourceLayout.Buffer
callocStack(int capacity)
Returns a newVkSubresourceLayout.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkSubresourceLayout.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkSubresourceLayout.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSubresourceLayout
callocStack(MemoryStack stack)
Returns a newVkSubresourceLayout
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSubresourceLayout
create()
Returns a newVkSubresourceLayout
instance allocated withBufferUtils
.static VkSubresourceLayout.Buffer
create(int capacity)
Returns a newVkSubresourceLayout.Buffer
instance allocated withBufferUtils
.static VkSubresourceLayout
create(long address)
Returns a newVkSubresourceLayout
instance for the specified memory address ornull
if the address isNULL
.static VkSubresourceLayout.Buffer
create(long address, int capacity)
Create aVkSubresourceLayout.Buffer
instance at the specified memory.long
depthPitch()
Returns the value of thedepthPitch
field.static VkSubresourceLayout
malloc()
Returns a newVkSubresourceLayout
instance allocated withmemAlloc
.static VkSubresourceLayout.Buffer
malloc(int capacity)
Returns a newVkSubresourceLayout.Buffer
instance allocated withmemAlloc
.static VkSubresourceLayout
mallocStack()
Returns a newVkSubresourceLayout
instance allocated on the thread-localMemoryStack
.static VkSubresourceLayout.Buffer
mallocStack(int capacity)
Returns a newVkSubresourceLayout.Buffer
instance allocated on the thread-localMemoryStack
.static VkSubresourceLayout.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkSubresourceLayout.Buffer
instance allocated on the specifiedMemoryStack
.static VkSubresourceLayout
mallocStack(MemoryStack stack)
Returns a newVkSubresourceLayout
instance allocated on the specifiedMemoryStack
.long
offset()
Returns the value of theoffset
field.long
rowPitch()
Returns the value of therowPitch
field.long
size()
Returns the value of thesize
field.int
sizeof()
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 aVkSubresourceLayout
instance at the current position of the specifiedByteBuffer
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 Detail
-
sizeof
public int sizeof()
Description copied from class:Struct
Returns thesizeof(struct)
.
-
offset
public long offset()
Returns the value of theoffset
field.
-
size
public long size()
Returns the value of thesize
field.
-
rowPitch
public long rowPitch()
Returns the value of therowPitch
field.
-
arrayPitch
public long arrayPitch()
Returns the value of thearrayPitch
field.
-
depthPitch
public long depthPitch()
Returns the value of thedepthPitch
field.
-
malloc
public static VkSubresourceLayout malloc()
Returns a newVkSubresourceLayout
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkSubresourceLayout calloc()
Returns a newVkSubresourceLayout
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkSubresourceLayout create()
Returns a newVkSubresourceLayout
instance allocated withBufferUtils
.
-
create
public static VkSubresourceLayout create(long address)
Returns a newVkSubresourceLayout
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkSubresourceLayout.Buffer malloc(int capacity)
Returns a newVkSubresourceLayout.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkSubresourceLayout.Buffer calloc(int capacity)
Returns a newVkSubresourceLayout.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkSubresourceLayout.Buffer create(int capacity)
Returns a newVkSubresourceLayout.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkSubresourceLayout.Buffer create(long address, int capacity)
Create aVkSubresourceLayout.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkSubresourceLayout mallocStack()
Returns a newVkSubresourceLayout
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkSubresourceLayout callocStack()
Returns a newVkSubresourceLayout
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkSubresourceLayout mallocStack(MemoryStack stack)
Returns a newVkSubresourceLayout
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkSubresourceLayout callocStack(MemoryStack stack)
Returns a newVkSubresourceLayout
instance allocated on the specifiedMemoryStack
and 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.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkSubresourceLayout.Buffer callocStack(int capacity)
Returns a newVkSubresourceLayout.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkSubresourceLayout.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkSubresourceLayout.Buffer
instance 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.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-