Package org.lwjgl.vulkan
Class VkImageResolve
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkImageResolve
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkImageResolve extends Struct
Khronos Reference Page
Vulkan SpecificationSpecifies a region to resolve.
Valid Usage
srcSubresource
must be a validVkImageSubresourceLayers
structuredstSubresource
must be a validVkImageSubresourceLayers
structure- The
aspectMask
member ofsrcSubresource
anddstSubresource
must only containIMAGE_ASPECT_COLOR_BIT
- The
layerCount
member ofsrcSubresource
anddstSubresource
must match - If either of the calling command's
srcImage
ordstImage
parameters are ofVkImageType
IMAGE_TYPE_3D
, thebaseArrayLayer
andlayerCount
members of bothsrcSubresource
anddstSubresource
must be 0 and 1, respectively
Member documentation
srcSubresource
– aVkImageSubresourceLayers
structure specifying the image subresource of the image used for the source image datasrcOffset
– selects the initial x, y, and z offsets in texels of the sub-region of the source image datadstSubresource
– aVkImageSubresourceLayers
structure specifying the image subresource of the image used for the destination image datadstOffset
– selects the initial x, y, and z offsets in texels of the sub-region of the destination image dataextent
– the size in texels of the source image to resolve in width, height and depth
Layout
struct VkImageResolve {
VkImageSubresourceLayers
srcSubresource;VkOffset3D
srcOffset;VkImageSubresourceLayers
dstSubresource;VkOffset3D
dstOffset;VkExtent3D
extent; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkImageResolve.Buffer
An array ofVkImageResolve
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 VkImageResolve(java.nio.ByteBuffer container)
Creates aVkImageResolve
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 static VkImageResolve
calloc()
Returns a newVkImageResolve
instance allocated withmemCalloc
.static VkImageResolve.Buffer
calloc(int capacity)
Returns a newVkImageResolve.Buffer
instance allocated withmemCalloc
.static VkImageResolve
callocStack()
Returns a newVkImageResolve
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImageResolve.Buffer
callocStack(int capacity)
Returns a newVkImageResolve.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImageResolve.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkImageResolve.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImageResolve
callocStack(MemoryStack stack)
Returns a newVkImageResolve
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImageResolve
create()
Returns a newVkImageResolve
instance allocated withBufferUtils
.static VkImageResolve.Buffer
create(int capacity)
Returns a newVkImageResolve.Buffer
instance allocated withBufferUtils
.static VkImageResolve
create(long address)
Returns a newVkImageResolve
instance for the specified memory address ornull
if the address isNULL
.static VkImageResolve.Buffer
create(long address, int capacity)
Create aVkImageResolve.Buffer
instance at the specified memory.VkOffset3D
dstOffset()
Returns aVkOffset3D
view of thedstOffset
field.VkImageResolve
dstOffset(VkOffset3D value)
Copies the specifiedVkOffset3D
to thedstOffset
field.VkImageSubresourceLayers
dstSubresource()
Returns aVkImageSubresourceLayers
view of thedstSubresource
field.VkImageResolve
dstSubresource(VkImageSubresourceLayers value)
Copies the specifiedVkImageSubresourceLayers
to thedstSubresource
field.VkExtent3D
extent()
Returns aVkExtent3D
view of theextent
field.VkImageResolve
extent(VkExtent3D value)
Copies the specifiedVkExtent3D
to theextent
field.static VkImageResolve
malloc()
Returns a newVkImageResolve
instance allocated withmemAlloc
.static VkImageResolve.Buffer
malloc(int capacity)
Returns a newVkImageResolve.Buffer
instance allocated withmemAlloc
.static VkImageResolve
mallocStack()
Returns a newVkImageResolve
instance allocated on the thread-localMemoryStack
.static VkImageResolve.Buffer
mallocStack(int capacity)
Returns a newVkImageResolve.Buffer
instance allocated on the thread-localMemoryStack
.static VkImageResolve.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkImageResolve.Buffer
instance allocated on the specifiedMemoryStack
.static VkImageResolve
mallocStack(MemoryStack stack)
Returns a newVkImageResolve
instance allocated on the specifiedMemoryStack
.VkImageResolve
nset(long struct)
Unsafe version ofset
.VkImageResolve
set(VkImageResolve src)
Copies the specified struct data to this struct.VkImageResolve
set(VkImageSubresourceLayers srcSubresource, VkOffset3D srcOffset, VkImageSubresourceLayers dstSubresource, VkOffset3D dstOffset, VkExtent3D extent)
Initializes this struct with the specified values.int
sizeof()
Returns thesizeof(struct)
.VkOffset3D
srcOffset()
Returns aVkOffset3D
view of thesrcOffset
field.VkImageResolve
srcOffset(VkOffset3D value)
Copies the specifiedVkOffset3D
to thesrcOffset
field.VkImageSubresourceLayers
srcSubresource()
Returns aVkImageSubresourceLayers
view of thesrcSubresource
field.VkImageResolve
srcSubresource(VkImageSubresourceLayers value)
Copies the specifiedVkImageSubresourceLayers
to thesrcSubresource
field.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkImageResolve
public VkImageResolve(java.nio.ByteBuffer container)
Creates aVkImageResolve
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)
.
-
srcSubresource
public VkImageSubresourceLayers srcSubresource()
Returns aVkImageSubresourceLayers
view of thesrcSubresource
field.
-
srcOffset
public VkOffset3D srcOffset()
Returns aVkOffset3D
view of thesrcOffset
field.
-
dstSubresource
public VkImageSubresourceLayers dstSubresource()
Returns aVkImageSubresourceLayers
view of thedstSubresource
field.
-
dstOffset
public VkOffset3D dstOffset()
Returns aVkOffset3D
view of thedstOffset
field.
-
extent
public VkExtent3D extent()
Returns aVkExtent3D
view of theextent
field.
-
srcSubresource
public VkImageResolve srcSubresource(VkImageSubresourceLayers value)
Copies the specifiedVkImageSubresourceLayers
to thesrcSubresource
field.
-
srcOffset
public VkImageResolve srcOffset(VkOffset3D value)
Copies the specifiedVkOffset3D
to thesrcOffset
field.
-
dstSubresource
public VkImageResolve dstSubresource(VkImageSubresourceLayers value)
Copies the specifiedVkImageSubresourceLayers
to thedstSubresource
field.
-
dstOffset
public VkImageResolve dstOffset(VkOffset3D value)
Copies the specifiedVkOffset3D
to thedstOffset
field.
-
extent
public VkImageResolve extent(VkExtent3D value)
Copies the specifiedVkExtent3D
to theextent
field.
-
set
public VkImageResolve set(VkImageSubresourceLayers srcSubresource, VkOffset3D srcOffset, VkImageSubresourceLayers dstSubresource, VkOffset3D dstOffset, VkExtent3D extent)
Initializes this struct with the specified values.
-
nset
public VkImageResolve nset(long struct)
Unsafe version ofset
.
-
set
public VkImageResolve set(VkImageResolve src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkImageResolve malloc()
Returns a newVkImageResolve
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkImageResolve calloc()
Returns a newVkImageResolve
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkImageResolve create()
Returns a newVkImageResolve
instance allocated withBufferUtils
.
-
create
public static VkImageResolve create(long address)
Returns a newVkImageResolve
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkImageResolve.Buffer malloc(int capacity)
Returns a newVkImageResolve.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkImageResolve.Buffer calloc(int capacity)
Returns a newVkImageResolve.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImageResolve.Buffer create(int capacity)
Returns a newVkImageResolve.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImageResolve.Buffer create(long address, int capacity)
Create aVkImageResolve.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkImageResolve mallocStack()
Returns a newVkImageResolve
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkImageResolve callocStack()
Returns a newVkImageResolve
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkImageResolve mallocStack(MemoryStack stack)
Returns a newVkImageResolve
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkImageResolve callocStack(MemoryStack stack)
Returns a newVkImageResolve
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkImageResolve.Buffer mallocStack(int capacity)
Returns a newVkImageResolve.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkImageResolve.Buffer callocStack(int capacity)
Returns a newVkImageResolve.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkImageResolve.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkImageResolve.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkImageResolve.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkImageResolve.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-