Class VkImageStencilUsageCreateInfoEXT
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkImageStencilUsageCreateInfoEXT
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkImageStencilUsageCreateInfoEXT extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Specify separate usage flags for the stencil aspect of a depth-stencil image.Description
This structure specifies image usages which only apply to the stencil aspect of a depth/stencil format image. When this structure is included in the
pNext
chain ofVkImageCreateInfo
, the stencil aspect of the image must only be used as specified bystencilUsage
. When this structure is not included in thepNext
chain ofVkImageCreateInfo
, the stencil aspect of an image must only be used as specifiedVkImageCreateInfo
::usage
. Use of other aspects of an image are unaffected by this structure.This structure can also be included in the
pNext
chain ofVkPhysicalDeviceImageFormatInfo2
to query additional capabilities specific to image creation parameter combinations including a separate set of usage flags for the stencil aspect of the image usingGetPhysicalDeviceImageFormatProperties2
. When this structure is not present in thepNext
chain ofVkPhysicalDeviceImageFormatInfo2
then the implicit value ofstencilUsage
matches that ofVkPhysicalDeviceImageFormatInfo2
::usage
.Valid Usage
- If
stencilUsage
includesIMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT
, then bits other thanIMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
, andIMAGE_USAGE_INPUT_ATTACHMENT_BIT
must not be set
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_IMAGE_STENCIL_USAGE_CREATE_INFO_EXT
stencilUsage
must be a valid combination ofVkImageUsageFlagBits
valuesstencilUsage
must not be 0
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.stencilUsage
– a bitmask ofVkImageUsageFlagBits
describing the intended usage of the stencil aspect of the image.
Layout
struct VkImageStencilUsageCreateInfoEXT { VkStructureType sType; void const * pNext; VkImageUsageFlags stencilUsage; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkImageStencilUsageCreateInfoEXT.Buffer
An array ofVkImageStencilUsageCreateInfoEXT
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
PNEXT
The struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STENCILUSAGE
STYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkImageStencilUsageCreateInfoEXT(java.nio.ByteBuffer container)
Creates aVkImageStencilUsageCreateInfoEXT
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkImageStencilUsageCreateInfoEXT
calloc()
Returns a newVkImageStencilUsageCreateInfoEXT
instance allocated withmemCalloc
.static VkImageStencilUsageCreateInfoEXT.Buffer
calloc(int capacity)
Returns a newVkImageStencilUsageCreateInfoEXT.Buffer
instance allocated withmemCalloc
.static VkImageStencilUsageCreateInfoEXT
callocStack()
Returns a newVkImageStencilUsageCreateInfoEXT
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImageStencilUsageCreateInfoEXT.Buffer
callocStack(int capacity)
Returns a newVkImageStencilUsageCreateInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImageStencilUsageCreateInfoEXT.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImageStencilUsageCreateInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImageStencilUsageCreateInfoEXT
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImageStencilUsageCreateInfoEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImageStencilUsageCreateInfoEXT
create()
Returns a newVkImageStencilUsageCreateInfoEXT
instance allocated withBufferUtils
.static VkImageStencilUsageCreateInfoEXT.Buffer
create(int capacity)
Returns a newVkImageStencilUsageCreateInfoEXT.Buffer
instance allocated withBufferUtils
.static VkImageStencilUsageCreateInfoEXT
create(long address)
Returns a newVkImageStencilUsageCreateInfoEXT
instance for the specified memory address.static VkImageStencilUsageCreateInfoEXT.Buffer
create(long address, int capacity)
Create aVkImageStencilUsageCreateInfoEXT.Buffer
instance at the specified memory.static VkImageStencilUsageCreateInfoEXT
createSafe(long address)
static VkImageStencilUsageCreateInfoEXT.Buffer
createSafe(long address, int capacity)
static VkImageStencilUsageCreateInfoEXT
malloc()
Returns a newVkImageStencilUsageCreateInfoEXT
instance allocated withmemAlloc
.static VkImageStencilUsageCreateInfoEXT.Buffer
malloc(int capacity)
Returns a newVkImageStencilUsageCreateInfoEXT.Buffer
instance allocated withmemAlloc
.static VkImageStencilUsageCreateInfoEXT
mallocStack()
Returns a newVkImageStencilUsageCreateInfoEXT
instance allocated on the thread-localMemoryStack
.static VkImageStencilUsageCreateInfoEXT.Buffer
mallocStack(int capacity)
Returns a newVkImageStencilUsageCreateInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
.static VkImageStencilUsageCreateInfoEXT.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImageStencilUsageCreateInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
.static VkImageStencilUsageCreateInfoEXT
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImageStencilUsageCreateInfoEXT
instance allocated on the specifiedMemoryStack
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static int
nstencilUsage(long struct)
Unsafe version ofstencilUsage()
.static void
nstencilUsage(long struct, int value)
Unsafe version ofstencilUsage
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.long
pNext()
Returns the value of thepNext
field.VkImageStencilUsageCreateInfoEXT
pNext(long value)
Sets the specified value to thepNext
field.VkImageStencilUsageCreateInfoEXT
set(int sType, long pNext, int stencilUsage)
Initializes this struct with the specified values.VkImageStencilUsageCreateInfoEXT
set(VkImageStencilUsageCreateInfoEXT src)
Copies the specified struct data to this struct.int
sizeof()
int
stencilUsage()
Returns the value of thestencilUsage
field.VkImageStencilUsageCreateInfoEXT
stencilUsage(int value)
Sets the specified value to thestencilUsage
field.int
sType()
Returns the value of thesType
field.VkImageStencilUsageCreateInfoEXT
sType(int value)
Sets the specified value to thesType
field.
-
-
-
Constructor Detail
-
VkImageStencilUsageCreateInfoEXT
public VkImageStencilUsageCreateInfoEXT(java.nio.ByteBuffer container)
Creates aVkImageStencilUsageCreateInfoEXT
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()
- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
stencilUsage
public int stencilUsage()
Returns the value of thestencilUsage
field.
-
sType
public VkImageStencilUsageCreateInfoEXT sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkImageStencilUsageCreateInfoEXT pNext(long value)
Sets the specified value to thepNext
field.
-
stencilUsage
public VkImageStencilUsageCreateInfoEXT stencilUsage(int value)
Sets the specified value to thestencilUsage
field.
-
set
public VkImageStencilUsageCreateInfoEXT set(int sType, long pNext, int stencilUsage)
Initializes this struct with the specified values.
-
set
public VkImageStencilUsageCreateInfoEXT set(VkImageStencilUsageCreateInfoEXT src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkImageStencilUsageCreateInfoEXT malloc()
Returns a newVkImageStencilUsageCreateInfoEXT
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkImageStencilUsageCreateInfoEXT calloc()
Returns a newVkImageStencilUsageCreateInfoEXT
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkImageStencilUsageCreateInfoEXT create()
Returns a newVkImageStencilUsageCreateInfoEXT
instance allocated withBufferUtils
.
-
create
public static VkImageStencilUsageCreateInfoEXT create(long address)
Returns a newVkImageStencilUsageCreateInfoEXT
instance for the specified memory address.
-
createSafe
@Nullable public static VkImageStencilUsageCreateInfoEXT createSafe(long address)
-
malloc
public static VkImageStencilUsageCreateInfoEXT.Buffer malloc(int capacity)
Returns a newVkImageStencilUsageCreateInfoEXT.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkImageStencilUsageCreateInfoEXT.Buffer calloc(int capacity)
Returns a newVkImageStencilUsageCreateInfoEXT.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImageStencilUsageCreateInfoEXT.Buffer create(int capacity)
Returns a newVkImageStencilUsageCreateInfoEXT.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImageStencilUsageCreateInfoEXT.Buffer create(long address, int capacity)
Create aVkImageStencilUsageCreateInfoEXT.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkImageStencilUsageCreateInfoEXT.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkImageStencilUsageCreateInfoEXT mallocStack()
Returns a newVkImageStencilUsageCreateInfoEXT
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkImageStencilUsageCreateInfoEXT callocStack()
Returns a newVkImageStencilUsageCreateInfoEXT
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkImageStencilUsageCreateInfoEXT mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImageStencilUsageCreateInfoEXT
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkImageStencilUsageCreateInfoEXT callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImageStencilUsageCreateInfoEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkImageStencilUsageCreateInfoEXT.Buffer mallocStack(int capacity)
Returns a newVkImageStencilUsageCreateInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkImageStencilUsageCreateInfoEXT.Buffer callocStack(int capacity)
Returns a newVkImageStencilUsageCreateInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkImageStencilUsageCreateInfoEXT.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImageStencilUsageCreateInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkImageStencilUsageCreateInfoEXT.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImageStencilUsageCreateInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType()
.
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext()
.
-
nstencilUsage
public static int nstencilUsage(long struct)
Unsafe version ofstencilUsage()
.
-
nsType
public static void nsType(long struct, int value)
Unsafe version ofsType
.
-
npNext
public static void npNext(long struct, long value)
Unsafe version ofpNext
.
-
nstencilUsage
public static void nstencilUsage(long struct, int value)
Unsafe version ofstencilUsage
.
-
-