Package org.lwjgl.vulkan

Class VkImageViewMinLodCreateInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkImageViewMinLodCreateInfoEXT>

org.lwjgl.vulkan.VkImageViewMinLodCreateInfoEXT

All Implemented Interfaces:

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

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

Structure describing the minimum LOD of an image view.

Description

If the pNext chain includes a VkImageViewMinLodCreateInfoEXT structure, then that structure includes a parameter specifying a value to clamp the minimum LOD value during Image Level(s) Selection, Texel Gathering and Integer Texel Coordinate Operations.

If the image view contains VkImageViewMinLodCreateInfoEXT and it is used as part of a sampling operation:

minLodFloatimageView = minLod

otherwise:

minLodFloatimageView = 0.0

An integer variant of this parameter is also defined for sampling operations which access integer mipmap levels:

minLodIntegerimageView = ⌊minLodFloatimageView⌋

Valid Usage

• If the minLod feature is not enabled, minLod must be 0.0
• minLod must be less or equal to the index of the last mipmap level accessible to the view

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMAGE_VIEW_MIN_LOD_CREATE_INFO_EXT

Layout

 struct VkImageViewMinLodCreateInfoEXT {
     VkStructureType sType();
     void const * pNext();
     float minLod();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkImageViewMinLodCreateInfoEXT.Buffer	An array of VkImageViewMinLodCreateInfoEXT 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	MINLOD	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
VkImageViewMinLodCreateInfoEXT(ByteBuffer container)	Creates a VkImageViewMinLodCreateInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkImageViewMinLodCreateInfoEXT	calloc()	Returns a new VkImageViewMinLodCreateInfoEXT instance allocated with memCalloc.
static VkImageViewMinLodCreateInfoEXT.Buffer	calloc(int capacity)	Returns a new VkImageViewMinLodCreateInfoEXT.Buffer instance allocated with memCalloc.
static VkImageViewMinLodCreateInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImageViewMinLodCreateInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageViewMinLodCreateInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImageViewMinLodCreateInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageViewMinLodCreateInfoEXT	create()	Returns a new VkImageViewMinLodCreateInfoEXT instance allocated with BufferUtils.
static VkImageViewMinLodCreateInfoEXT.Buffer	create(int capacity)	Returns a new VkImageViewMinLodCreateInfoEXT.Buffer instance allocated with BufferUtils.
static VkImageViewMinLodCreateInfoEXT	create(long address)	Returns a new VkImageViewMinLodCreateInfoEXT instance for the specified memory address.
static VkImageViewMinLodCreateInfoEXT.Buffer	create(long address, int capacity)	Create a VkImageViewMinLodCreateInfoEXT.Buffer instance at the specified memory.
static @Nullable VkImageViewMinLodCreateInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkImageViewMinLodCreateInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkImageViewMinLodCreateInfoEXT	malloc()	Returns a new VkImageViewMinLodCreateInfoEXT instance allocated with memAlloc.
static VkImageViewMinLodCreateInfoEXT.Buffer	malloc(int capacity)	Returns a new VkImageViewMinLodCreateInfoEXT.Buffer instance allocated with memAlloc.
static VkImageViewMinLodCreateInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImageViewMinLodCreateInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkImageViewMinLodCreateInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImageViewMinLodCreateInfoEXT instance allocated on the specified MemoryStack.
float	minLod()	the value to clamp the minimum LOD accessible by this VkImageView.
VkImageViewMinLodCreateInfoEXT	minLod(float value)	Sets the specified value to the minLod() field.
static float	nminLod(long struct)	Unsafe version of minLod().
static void	nminLod(long struct, float value)	Unsafe version of minLod.
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.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkImageViewMinLodCreateInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkImageViewMinLodCreateInfoEXT	set(int sType, long pNext, float minLod)	Initializes this struct with the specified values.
VkImageViewMinLodCreateInfoEXT	set(VkImageViewMinLodCreateInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkImageViewMinLodCreateInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkImageViewMinLodCreateInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_IMAGE_VIEW_MIN_LOD_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.

MINLOD

public static final int MINLOD

The struct member offsets.

Constructor Details

VkImageViewMinLodCreateInfoEXT

public VkImageViewMinLodCreateInfoEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

minLod

public float minLod()

the value to clamp the minimum LOD accessible by this VkImageView.

sType

public VkImageViewMinLodCreateInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkImageViewMinLodCreateInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_VIEW_MIN_LOD_CREATE_INFO_EXT value to the sType() field.

pNext

public VkImageViewMinLodCreateInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

minLod

public VkImageViewMinLodCreateInfoEXT minLod(float value)

Sets the specified value to the minLod() field.

set

public VkImageViewMinLodCreateInfoEXT set(int sType,
 long pNext,
 float minLod)

Initializes this struct with the specified values.

set

public VkImageViewMinLodCreateInfoEXT set(VkImageViewMinLodCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkImageViewMinLodCreateInfoEXT malloc()

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

calloc

public static VkImageViewMinLodCreateInfoEXT calloc()

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

create

public static VkImageViewMinLodCreateInfoEXT create()

Returns a new VkImageViewMinLodCreateInfoEXT instance allocated with BufferUtils.

create

public static VkImageViewMinLodCreateInfoEXT create(long address)

Returns a new VkImageViewMinLodCreateInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkImageViewMinLodCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkImageViewMinLodCreateInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkImageViewMinLodCreateInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkImageViewMinLodCreateInfoEXT.Buffer create(int capacity)

Returns a new VkImageViewMinLodCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkImageViewMinLodCreateInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkImageViewMinLodCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkImageViewMinLodCreateInfoEXT.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().

nminLod

public static float nminLod(long struct)

Unsafe version of minLod().

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.

nminLod

public static void nminLod(long struct,
 float value)

Unsafe version of minLod.