Package org.lwjgl.vulkan

Class VkClearDepthStencilValue

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkClearDepthStencilValue>

org.lwjgl.vulkan.VkClearDepthStencilValue

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkClearDepthStencilValue
extends Struct<VkClearDepthStencilValue>
implements NativeResource

Structure specifying a clear depth stencil value.

Valid Usage

• Unless the VK_EXT_depth_range_unrestricted extension is enabled depth must be between 0.0 and 1.0, inclusive

See Also

VkClearValue, CmdClearDepthStencilImage

Layout

 struct VkClearDepthStencilValue {
     float depth();
     uint32_t stencil();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkClearDepthStencilValue.Buffer	An array of VkClearDepthStencilValue 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	DEPTH	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STENCIL	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
VkClearDepthStencilValue(ByteBuffer container)	Creates a VkClearDepthStencilValue instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkClearDepthStencilValue	calloc()	Returns a new VkClearDepthStencilValue instance allocated with memCalloc.
static VkClearDepthStencilValue.Buffer	calloc(int capacity)	Returns a new VkClearDepthStencilValue.Buffer instance allocated with memCalloc.
static VkClearDepthStencilValue.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkClearDepthStencilValue.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkClearDepthStencilValue	calloc(MemoryStack stack)	Returns a new VkClearDepthStencilValue instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkClearDepthStencilValue	callocStack()	Deprecated.
static VkClearDepthStencilValue.Buffer	callocStack(int capacity)	Deprecated.
static VkClearDepthStencilValue.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkClearDepthStencilValue	callocStack(MemoryStack stack)	Deprecated.
static VkClearDepthStencilValue	create()	Returns a new VkClearDepthStencilValue instance allocated with BufferUtils.
static VkClearDepthStencilValue.Buffer	create(int capacity)	Returns a new VkClearDepthStencilValue.Buffer instance allocated with BufferUtils.
static VkClearDepthStencilValue	create(long address)	Returns a new VkClearDepthStencilValue instance for the specified memory address.
static VkClearDepthStencilValue.Buffer	create(long address, int capacity)	Create a VkClearDepthStencilValue.Buffer instance at the specified memory.
static VkClearDepthStencilValue	createSafe(long address)	Like create, but returns null if address is NULL.
static VkClearDepthStencilValue.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
float	depth()	the clear value for the depth aspect of the depth/stencil attachment.
VkClearDepthStencilValue	depth(float value)	Sets the specified value to the depth() field.
static VkClearDepthStencilValue	malloc()	Returns a new VkClearDepthStencilValue instance allocated with memAlloc.
static VkClearDepthStencilValue.Buffer	malloc(int capacity)	Returns a new VkClearDepthStencilValue.Buffer instance allocated with memAlloc.
static VkClearDepthStencilValue.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkClearDepthStencilValue.Buffer instance allocated on the specified MemoryStack.
static VkClearDepthStencilValue	malloc(MemoryStack stack)	Returns a new VkClearDepthStencilValue instance allocated on the specified MemoryStack.
static VkClearDepthStencilValue	mallocStack()	Deprecated.
static VkClearDepthStencilValue.Buffer	mallocStack(int capacity)	Deprecated.
static VkClearDepthStencilValue.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkClearDepthStencilValue	mallocStack(MemoryStack stack)	Deprecated.
static float	ndepth(long struct)	Unsafe version of depth().
static void	ndepth(long struct, float value)	Unsafe version of depth.
static int	nstencil(long struct)	Unsafe version of stencil().
static void	nstencil(long struct, int value)	Unsafe version of stencil.
VkClearDepthStencilValue	set(float depth, int stencil)	Initializes this struct with the specified values.
VkClearDepthStencilValue	set(VkClearDepthStencilValue src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	stencil()	the clear value for the stencil aspect of the depth/stencil attachment.
VkClearDepthStencilValue	stencil(int value)	Sets the specified value to the stencil() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, 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.

DEPTH

public static final int DEPTH

The struct member offsets.

STENCIL

public static final int STENCIL

The struct member offsets.

Constructor Details

VkClearDepthStencilValue

public VkClearDepthStencilValue(ByteBuffer container)

Creates a VkClearDepthStencilValue 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<VkClearDepthStencilValue>

depth

public float depth()

the clear value for the depth aspect of the depth/stencil attachment. It is a floating-point value which is automatically converted to the attachment’s format.

stencil

public int stencil()

the clear value for the stencil aspect of the depth/stencil attachment. It is a 32-bit integer value which is converted to the attachment’s format by taking the appropriate number of LSBs.

depth

public VkClearDepthStencilValue depth(float value)

Sets the specified value to the depth() field.

stencil

public VkClearDepthStencilValue stencil(int value)

Sets the specified value to the stencil() field.

set

public VkClearDepthStencilValue set(float depth,
 int stencil)

Initializes this struct with the specified values.

set

public VkClearDepthStencilValue set(VkClearDepthStencilValue src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkClearDepthStencilValue malloc()

Returns a new VkClearDepthStencilValue instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkClearDepthStencilValue calloc()

Returns a new VkClearDepthStencilValue instance allocated with memCalloc. The instance must be explicitly freed.

create

public static VkClearDepthStencilValue create()

Returns a new VkClearDepthStencilValue instance allocated with BufferUtils.

create

public static VkClearDepthStencilValue create(long address)

Returns a new VkClearDepthStencilValue instance for the specified memory address.

createSafe

@Nullable
public static VkClearDepthStencilValue createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkClearDepthStencilValue.Buffer malloc(int capacity)

Returns a new VkClearDepthStencilValue.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkClearDepthStencilValue.Buffer calloc(int capacity)

Returns a new VkClearDepthStencilValue.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkClearDepthStencilValue.Buffer create(int capacity)

Returns a new VkClearDepthStencilValue.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkClearDepthStencilValue.Buffer create(long address,
 int capacity)

Create a VkClearDepthStencilValue.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

@Nullable
public static VkClearDepthStencilValue.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkClearDepthStencilValue mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkClearDepthStencilValue callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkClearDepthStencilValue mallocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkClearDepthStencilValue callocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkClearDepthStencilValue.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkClearDepthStencilValue.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VkClearDepthStencilValue.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkClearDepthStencilValue.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static VkClearDepthStencilValue malloc(MemoryStack stack)

Returns a new VkClearDepthStencilValue instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkClearDepthStencilValue calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkClearDepthStencilValue.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkClearDepthStencilValue.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new VkClearDepthStencilValue.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

ndepth

public static float ndepth(long struct)

Unsafe version of depth().

nstencil

public static int nstencil(long struct)

Unsafe version of stencil().

ndepth

public static void ndepth(long struct,
 float value)

Unsafe version of depth.

nstencil

public static void nstencil(long struct,
 int value)

Unsafe version of stencil.