Package org.lwjgl.vulkan

Class VkImageFormatProperties

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkImageFormatProperties>

org.lwjgl.vulkan.VkImageFormatProperties

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkImageFormatProperties
extends Struct<VkImageFormatProperties>
implements NativeResource

 struct VkImageFormatProperties {
     {@link VkExtent3D VkExtent3D} maxExtent;
     uint32_t maxMipLevels;
     uint32_t maxArrayLayers;
     VkSampleCountFlags sampleCounts;
     VkDeviceSize maxResourceSize;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkImageFormatProperties.Buffer	An array of VkImageFormatProperties 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	MAXARRAYLAYERS	The struct member offsets.
static final int	MAXEXTENT	The struct member offsets.
static final int	MAXMIPLEVELS	The struct member offsets.
static final int	MAXRESOURCESIZE	The struct member offsets.
static final int	SAMPLECOUNTS	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkImageFormatProperties(ByteBuffer container)	Creates a VkImageFormatProperties instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkImageFormatProperties	calloc()	Returns a new VkImageFormatProperties instance allocated with memCalloc.
static VkImageFormatProperties.Buffer	calloc(int capacity)	Returns a new VkImageFormatProperties.Buffer instance allocated with memCalloc.
static VkImageFormatProperties.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkImageFormatProperties.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageFormatProperties	calloc(MemoryStack stack)	Returns a new VkImageFormatProperties instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageFormatProperties	callocStack()	Deprecated.
static VkImageFormatProperties.Buffer	callocStack(int capacity)	Deprecated.
static VkImageFormatProperties.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkImageFormatProperties	callocStack(MemoryStack stack)	Deprecated.
static VkImageFormatProperties	create()	Returns a new VkImageFormatProperties instance allocated with BufferUtils.
static VkImageFormatProperties.Buffer	create(int capacity)	Returns a new VkImageFormatProperties.Buffer instance allocated with BufferUtils.
static VkImageFormatProperties	create(long address)	Returns a new VkImageFormatProperties instance for the specified memory address.
static VkImageFormatProperties.Buffer	create(long address, int capacity)	Create a VkImageFormatProperties.Buffer instance at the specified memory.
static @Nullable VkImageFormatProperties	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkImageFormatProperties.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkImageFormatProperties	malloc()	Returns a new VkImageFormatProperties instance allocated with memAlloc.
static VkImageFormatProperties.Buffer	malloc(int capacity)	Returns a new VkImageFormatProperties.Buffer instance allocated with memAlloc.
static VkImageFormatProperties.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkImageFormatProperties.Buffer instance allocated on the specified MemoryStack.
static VkImageFormatProperties	malloc(MemoryStack stack)	Returns a new VkImageFormatProperties instance allocated on the specified MemoryStack.
static VkImageFormatProperties	mallocStack()	Deprecated.
static VkImageFormatProperties.Buffer	mallocStack(int capacity)	Deprecated.
static VkImageFormatProperties.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkImageFormatProperties	mallocStack(MemoryStack stack)	Deprecated.
int	maxArrayLayers()
VkExtent3D	maxExtent()
int	maxMipLevels()
long	maxResourceSize()
static int	nmaxArrayLayers(long struct)	Unsafe version of maxArrayLayers().
static VkExtent3D	nmaxExtent(long struct)	Unsafe version of maxExtent().
static int	nmaxMipLevels(long struct)	Unsafe version of maxMipLevels().
static long	nmaxResourceSize(long struct)	Unsafe version of maxResourceSize().
static int	nsampleCounts(long struct)	Unsafe version of sampleCounts().
int	sampleCounts()
int	sizeof()	Returns sizeof(struct).

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.

MAXEXTENT

public static final int MAXEXTENT

The struct member offsets.

MAXMIPLEVELS

public static final int MAXMIPLEVELS

The struct member offsets.

MAXARRAYLAYERS

public static final int MAXARRAYLAYERS

The struct member offsets.

SAMPLECOUNTS

public static final int SAMPLECOUNTS

The struct member offsets.

MAXRESOURCESIZE

public static final int MAXRESOURCESIZE

The struct member offsets.

Constructor Details

VkImageFormatProperties

public VkImageFormatProperties(ByteBuffer container)

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

maxExtent

public VkExtent3D maxExtent()

Returns:

a VkExtent3D view of the maxExtent field.

maxMipLevels

public int maxMipLevels()

Returns:

the value of the maxMipLevels field.

maxArrayLayers

public int maxArrayLayers()

Returns:

the value of the maxArrayLayers field.

sampleCounts

public int sampleCounts()

Returns:

the value of the sampleCounts field.

maxResourceSize

public long maxResourceSize()

Returns:

the value of the maxResourceSize field.

malloc

public static VkImageFormatProperties malloc()

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

calloc

public static VkImageFormatProperties calloc()

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

create

public static VkImageFormatProperties create()

Returns a new VkImageFormatProperties instance allocated with BufferUtils.

create

public static VkImageFormatProperties create(long address)

Returns a new VkImageFormatProperties instance for the specified memory address.

createSafe

public static @Nullable VkImageFormatProperties createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkImageFormatProperties.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkImageFormatProperties.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkImageFormatProperties.Buffer create(int capacity)

Returns a new VkImageFormatProperties.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkImageFormatProperties.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkImageFormatProperties mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkImageFormatProperties callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkImageFormatProperties mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkImageFormatProperties callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

malloc

public static VkImageFormatProperties malloc(MemoryStack stack)

Returns a new VkImageFormatProperties instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkImageFormatProperties calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nmaxExtent

public static VkExtent3D nmaxExtent(long struct)

Unsafe version of maxExtent().

nmaxMipLevels

public static int nmaxMipLevels(long struct)

Unsafe version of maxMipLevels().

nmaxArrayLayers

public static int nmaxArrayLayers(long struct)

Unsafe version of maxArrayLayers().

nsampleCounts

public static int nsampleCounts(long struct)

Unsafe version of sampleCounts().

nmaxResourceSize

public static long nmaxResourceSize(long struct)

Unsafe version of maxResourceSize().