Package org.lwjgl.vulkan

Class VkPipelineViewportDepthClampControlCreateInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPipelineViewportDepthClampControlCreateInfoEXT>

org.lwjgl.vulkan.VkPipelineViewportDepthClampControlCreateInfoEXT

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkPipelineViewportDepthClampControlCreateInfoEXT
extends org.lwjgl.system.Struct<VkPipelineViewportDepthClampControlCreateInfoEXT>
implements org.lwjgl.system.NativeResource

Structure specifying parameters of a newly created pipeline depth clamp control state.

Description

This structure extends VkPipelineViewportStateCreateInfo and specifies the depth clamp range used in the pipeline. If this structure is not provided in the next chain then depthClampMode defaults to DEPTH_CLAMP_MODE_VIEWPORT_RANGE_EXT.

Valid Usage

• If depthClampMode is DEPTH_CLAMP_MODE_USER_DEFINED_RANGE_EXT, and the pipeline is not created with DYNAMIC_STATE_DEPTH_CLAMP_RANGE_EXT, then pDepthClampRange must be a valid pointer to a valid VkDepthClampRangeEXT structure

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_VIEWPORT_DEPTH_CLAMP_CONTROL_CREATE_INFO_EXT
• depthClampMode must be a valid VkDepthClampModeEXT value
• If pDepthClampRange is not NULL, pDepthClampRange must be a valid pointer to a valid VkDepthClampRangeEXT structure

See Also

VkDepthClampRangeEXT

Layout

 struct VkPipelineViewportDepthClampControlCreateInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkDepthClampModeEXT depthClampMode();
     VkDepthClampRangeEXT const * pDepthClampRange();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPipelineViewportDepthClampControlCreateInfoEXT.Buffer	An array of VkPipelineViewportDepthClampControlCreateInfoEXT structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	DEPTHCLAMPMODE	The struct member offsets.
static final int	PDEPTHCLAMPRANGE	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	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
VkPipelineViewportDepthClampControlCreateInfoEXT(ByteBuffer container)	Creates a VkPipelineViewportDepthClampControlCreateInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPipelineViewportDepthClampControlCreateInfoEXT	calloc()	Returns a new VkPipelineViewportDepthClampControlCreateInfoEXT instance allocated with memCalloc.
static VkPipelineViewportDepthClampControlCreateInfoEXT.Buffer	calloc(int capacity)	Returns a new VkPipelineViewportDepthClampControlCreateInfoEXT.Buffer instance allocated with memCalloc.
static VkPipelineViewportDepthClampControlCreateInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineViewportDepthClampControlCreateInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineViewportDepthClampControlCreateInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineViewportDepthClampControlCreateInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineViewportDepthClampControlCreateInfoEXT	create()	Returns a new VkPipelineViewportDepthClampControlCreateInfoEXT instance allocated with BufferUtils.
static VkPipelineViewportDepthClampControlCreateInfoEXT.Buffer	create(int capacity)	Returns a new VkPipelineViewportDepthClampControlCreateInfoEXT.Buffer instance allocated with BufferUtils.
static VkPipelineViewportDepthClampControlCreateInfoEXT	create(long address)	Returns a new VkPipelineViewportDepthClampControlCreateInfoEXT instance for the specified memory address.
static VkPipelineViewportDepthClampControlCreateInfoEXT.Buffer	create(long address, int capacity)	Create a VkPipelineViewportDepthClampControlCreateInfoEXT.Buffer instance at the specified memory.
static @Nullable VkPipelineViewportDepthClampControlCreateInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPipelineViewportDepthClampControlCreateInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	depthClampMode()	determines how the clamp range is determined for each viewport.
VkPipelineViewportDepthClampControlCreateInfoEXT	depthClampMode(int value)	Sets the specified value to the depthClampMode() field.
static VkPipelineViewportDepthClampControlCreateInfoEXT	malloc()	Returns a new VkPipelineViewportDepthClampControlCreateInfoEXT instance allocated with memAlloc.
static VkPipelineViewportDepthClampControlCreateInfoEXT.Buffer	malloc(int capacity)	Returns a new VkPipelineViewportDepthClampControlCreateInfoEXT.Buffer instance allocated with memAlloc.
static VkPipelineViewportDepthClampControlCreateInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineViewportDepthClampControlCreateInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkPipelineViewportDepthClampControlCreateInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineViewportDepthClampControlCreateInfoEXT instance allocated on the specified MemoryStack.
static int	ndepthClampMode(long struct)	Unsafe version of depthClampMode().
static void	ndepthClampMode(long struct, int value)	Unsafe version of depthClampMode.
static @Nullable VkDepthClampRangeEXT	npDepthClampRange(long struct)	Unsafe version of pDepthClampRange().
static void	npDepthClampRange(long struct, @Nullable VkDepthClampRangeEXT value)	Unsafe version of pDepthClampRange.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
@Nullable VkDepthClampRangeEXT	pDepthClampRange()	sets the depth clamp range for all viewports if depthClampMode is DEPTH_CLAMP_MODE_USER_DEFINED_RANGE_EXT.
VkPipelineViewportDepthClampControlCreateInfoEXT	pDepthClampRange(@Nullable VkDepthClampRangeEXT value)	Sets the address of the specified VkDepthClampRangeEXT to the pDepthClampRange() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkPipelineViewportDepthClampControlCreateInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkPipelineViewportDepthClampControlCreateInfoEXT	set(int sType, long pNext, int depthClampMode, @Nullable VkDepthClampRangeEXT pDepthClampRange)	Initializes this struct with the specified values.
VkPipelineViewportDepthClampControlCreateInfoEXT	set(VkPipelineViewportDepthClampControlCreateInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPipelineViewportDepthClampControlCreateInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkPipelineViewportDepthClampControlCreateInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_PIPELINE_VIEWPORT_DEPTH_CLAMP_CONTROL_CREATE_INFO_EXT value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

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

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

DEPTHCLAMPMODE

public static final int DEPTHCLAMPMODE

The struct member offsets.

PDEPTHCLAMPRANGE

public static final int PDEPTHCLAMPRANGE

The struct member offsets.

Constructor Details

VkPipelineViewportDepthClampControlCreateInfoEXT

public VkPipelineViewportDepthClampControlCreateInfoEXT(ByteBuffer container)

Creates a VkPipelineViewportDepthClampControlCreateInfoEXT 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()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkPipelineViewportDepthClampControlCreateInfoEXT>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

depthClampMode

public int depthClampMode()

determines how the clamp range is determined for each viewport.

pDepthClampRange

public @Nullable VkDepthClampRangeEXT pDepthClampRange()

sets the depth clamp range for all viewports if depthClampMode is DEPTH_CLAMP_MODE_USER_DEFINED_RANGE_EXT.

sType

public VkPipelineViewportDepthClampControlCreateInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPipelineViewportDepthClampControlCreateInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_PIPELINE_VIEWPORT_DEPTH_CLAMP_CONTROL_CREATE_INFO_EXT value to the sType() field.

pNext

public VkPipelineViewportDepthClampControlCreateInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

depthClampMode

public VkPipelineViewportDepthClampControlCreateInfoEXT depthClampMode(int value)

Sets the specified value to the depthClampMode() field.

pDepthClampRange

public VkPipelineViewportDepthClampControlCreateInfoEXT pDepthClampRange(@Nullable VkDepthClampRangeEXT value)

Sets the address of the specified VkDepthClampRangeEXT to the pDepthClampRange() field.

set

public VkPipelineViewportDepthClampControlCreateInfoEXT set(int sType,
 long pNext,
 int depthClampMode,
 @Nullable VkDepthClampRangeEXT pDepthClampRange)

Initializes this struct with the specified values.

set

public VkPipelineViewportDepthClampControlCreateInfoEXT set(VkPipelineViewportDepthClampControlCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPipelineViewportDepthClampControlCreateInfoEXT malloc()

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

calloc

public static VkPipelineViewportDepthClampControlCreateInfoEXT calloc()

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

create

public static VkPipelineViewportDepthClampControlCreateInfoEXT create()

Returns a new VkPipelineViewportDepthClampControlCreateInfoEXT instance allocated with BufferUtils.

create

public static VkPipelineViewportDepthClampControlCreateInfoEXT create(long address)

Returns a new VkPipelineViewportDepthClampControlCreateInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkPipelineViewportDepthClampControlCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPipelineViewportDepthClampControlCreateInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPipelineViewportDepthClampControlCreateInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPipelineViewportDepthClampControlCreateInfoEXT.Buffer create(int capacity)

Returns a new VkPipelineViewportDepthClampControlCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPipelineViewportDepthClampControlCreateInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkPipelineViewportDepthClampControlCreateInfoEXT malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkPipelineViewportDepthClampControlCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkPipelineViewportDepthClampControlCreateInfoEXT calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkPipelineViewportDepthClampControlCreateInfoEXT.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkPipelineViewportDepthClampControlCreateInfoEXT.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

ndepthClampMode

public static int ndepthClampMode(long struct)

Unsafe version of depthClampMode().

npDepthClampRange

public static @Nullable VkDepthClampRangeEXT npDepthClampRange(long struct)

Unsafe version of pDepthClampRange().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

ndepthClampMode

public static void ndepthClampMode(long struct,
 int value)

Unsafe version of depthClampMode.

npDepthClampRange

public static void npDepthClampRange(long struct,
 @Nullable VkDepthClampRangeEXT value)

Unsafe version of pDepthClampRange.