Class VkSurfacePresentScalingCapabilitiesKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkSurfacePresentScalingCapabilitiesKHR>

org.lwjgl.vulkan.VkSurfacePresentScalingCapabilitiesKHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkSurfacePresentScalingCapabilitiesEXT

public class VkSurfacePresentScalingCapabilitiesKHR
extends Struct<VkSurfacePresentScalingCapabilitiesKHR>
implements NativeResource

struct VkSurfacePresentScalingCapabilitiesKHR {
    VkStructureType sType;
    void * pNext;
    VkPresentScalingFlagsKHR supportedPresentScaling;
    VkPresentGravityFlagsKHR supportedPresentGravityX;
    VkPresentGravityFlagsKHR supportedPresentGravityY;
    VkExtent2D minScaledImageExtent;
    VkExtent2D maxScaledImageExtent;
}

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	MAXSCALEDIMAGEEXTENT	The struct member offsets.
static final int	MINSCALEDIMAGEEXTENT	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.
static final int	SUPPORTEDPRESENTGRAVITYX	The struct member offsets.
static final int	SUPPORTEDPRESENTGRAVITYY	The struct member offsets.
static final int	SUPPORTEDPRESENTSCALING	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkSurfacePresentScalingCapabilitiesKHR	calloc()	Returns a new VkSurfacePresentScalingCapabilitiesKHR instance allocated with memCalloc.
static VkSurfacePresentScalingCapabilitiesKHR.Buffer	calloc(int capacity)	Returns a new VkSurfacePresentScalingCapabilitiesKHR.Buffer instance allocated with memCalloc.
static VkSurfacePresentScalingCapabilitiesKHR.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkSurfacePresentScalingCapabilitiesKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSurfacePresentScalingCapabilitiesKHR	calloc(MemoryStack stack)	Returns a new VkSurfacePresentScalingCapabilitiesKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSurfacePresentScalingCapabilitiesKHR	create()	Returns a new VkSurfacePresentScalingCapabilitiesKHR instance allocated with BufferUtils.
static VkSurfacePresentScalingCapabilitiesKHR.Buffer	create(int capacity)	Returns a new VkSurfacePresentScalingCapabilitiesKHR.Buffer instance allocated with BufferUtils.
static VkSurfacePresentScalingCapabilitiesKHR	create(long address)	Returns a new VkSurfacePresentScalingCapabilitiesKHR instance for the specified memory address.
static VkSurfacePresentScalingCapabilitiesKHR.Buffer	create(long address, int capacity)	Create a VkSurfacePresentScalingCapabilitiesKHR.Buffer instance at the specified memory.
static @Nullable VkSurfacePresentScalingCapabilitiesKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkSurfacePresentScalingCapabilitiesKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkSurfacePresentScalingCapabilitiesKHR	malloc()	Returns a new VkSurfacePresentScalingCapabilitiesKHR instance allocated with memAlloc.
static VkSurfacePresentScalingCapabilitiesKHR.Buffer	malloc(int capacity)	Returns a new VkSurfacePresentScalingCapabilitiesKHR.Buffer instance allocated with memAlloc.
static VkSurfacePresentScalingCapabilitiesKHR.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkSurfacePresentScalingCapabilitiesKHR.Buffer instance allocated on the specified MemoryStack.
static VkSurfacePresentScalingCapabilitiesKHR	malloc(MemoryStack stack)	Returns a new VkSurfacePresentScalingCapabilitiesKHR instance allocated on the specified MemoryStack.
VkExtent2D	maxScaledImageExtent()
VkSurfacePresentScalingCapabilitiesKHR	maxScaledImageExtent(Consumer<VkExtent2D> consumer)	Passes the maxScaledImageExtent field to the specified Consumer.
VkSurfacePresentScalingCapabilitiesKHR	maxScaledImageExtent(VkExtent2D value)	Copies the specified VkExtent2D to the maxScaledImageExtent field.
VkExtent2D	minScaledImageExtent()
VkSurfacePresentScalingCapabilitiesKHR	minScaledImageExtent(Consumer<VkExtent2D> consumer)	Passes the minScaledImageExtent field to the specified Consumer.
VkSurfacePresentScalingCapabilitiesKHR	minScaledImageExtent(VkExtent2D value)	Copies the specified VkExtent2D to the minScaledImageExtent field.
static VkExtent2D	nmaxScaledImageExtent(long struct)	Unsafe version of maxScaledImageExtent().
static void	nmaxScaledImageExtent(long struct, VkExtent2D value)	Unsafe version of maxScaledImageExtent.
static VkExtent2D	nminScaledImageExtent(long struct)	Unsafe version of minScaledImageExtent().
static void	nminScaledImageExtent(long struct, VkExtent2D value)	Unsafe version of minScaledImageExtent.
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.
static int	nsupportedPresentGravityX(long struct)	Unsafe version of supportedPresentGravityX().
static void	nsupportedPresentGravityX(long struct, int value)	Unsafe version of supportedPresentGravityX.
static int	nsupportedPresentGravityY(long struct)	Unsafe version of supportedPresentGravityY().
static void	nsupportedPresentGravityY(long struct, int value)	Unsafe version of supportedPresentGravityY.
static int	nsupportedPresentScaling(long struct)	Unsafe version of supportedPresentScaling().
static void	nsupportedPresentScaling(long struct, int value)	Unsafe version of supportedPresentScaling.
long	pNext()
VkSurfacePresentScalingCapabilitiesKHR	pNext(long value)	Sets the specified value to the pNext field.
VkSurfacePresentScalingCapabilitiesKHR	set(int sType, long pNext, int supportedPresentScaling, int supportedPresentGravityX, int supportedPresentGravityY, VkExtent2D minScaledImageExtent, VkExtent2D maxScaledImageExtent)	Initializes this struct with the specified values.
VkSurfacePresentScalingCapabilitiesKHR	set(VkSurfacePresentScalingCapabilitiesKHR src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()
VkSurfacePresentScalingCapabilitiesKHR	sType(int value)	Sets the specified value to the sType field.
VkSurfacePresentScalingCapabilitiesKHR	sType$Default()	Sets the STRUCTURE_TYPE_SURFACE_PRESENT_SCALING_CAPABILITIES_KHR value to the sType field.
int	supportedPresentGravityX()
VkSurfacePresentScalingCapabilitiesKHR	supportedPresentGravityX(int value)	Sets the specified value to the supportedPresentGravityX field.
int	supportedPresentGravityY()
VkSurfacePresentScalingCapabilitiesKHR	supportedPresentGravityY(int value)	Sets the specified value to the supportedPresentGravityY field.
int	supportedPresentScaling()
VkSurfacePresentScalingCapabilitiesKHR	supportedPresentScaling(int value)	Sets the specified value to the supportedPresentScaling field.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface 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.

SUPPORTEDPRESENTSCALING

public static final int SUPPORTEDPRESENTSCALING

The struct member offsets.

SUPPORTEDPRESENTGRAVITYX

public static final int SUPPORTEDPRESENTGRAVITYX

The struct member offsets.

SUPPORTEDPRESENTGRAVITYY

public static final int SUPPORTEDPRESENTGRAVITYY

The struct member offsets.

MINSCALEDIMAGEEXTENT

public static final int MINSCALEDIMAGEEXTENT

The struct member offsets.

MAXSCALEDIMAGEEXTENT

public static final int MAXSCALEDIMAGEEXTENT

The struct member offsets.

Constructor Details

VkSurfacePresentScalingCapabilitiesKHR

public VkSurfacePresentScalingCapabilitiesKHR(ByteBuffer container)

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

sType

@NativeType("VkStructureType")
public int sType()

Returns:

the value of the sType field.

pNext

@NativeType("void *")
public long pNext()

Returns:

the value of the pNext field.

supportedPresentScaling

@NativeType("VkPresentScalingFlagsKHR")
public int supportedPresentScaling()

Returns:

the value of the supportedPresentScaling field.

supportedPresentGravityX

@NativeType("VkPresentGravityFlagsKHR")
public int supportedPresentGravityX()

Returns:

the value of the supportedPresentGravityX field.

supportedPresentGravityY

@NativeType("VkPresentGravityFlagsKHR")
public int supportedPresentGravityY()

Returns:

the value of the supportedPresentGravityY field.

minScaledImageExtent

public VkExtent2D minScaledImageExtent()

Returns:

a VkExtent2D view of the minScaledImageExtent field.

maxScaledImageExtent

public VkExtent2D maxScaledImageExtent()

Returns:

a VkExtent2D view of the maxScaledImageExtent field.

sType

public VkSurfacePresentScalingCapabilitiesKHR sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

sType$Default

public VkSurfacePresentScalingCapabilitiesKHR sType$Default()

Sets the STRUCTURE_TYPE_SURFACE_PRESENT_SCALING_CAPABILITIES_KHR value to the sType field.

pNext

public VkSurfacePresentScalingCapabilitiesKHR pNext(@NativeType("void *")
 long value)

Sets the specified value to the pNext field.

supportedPresentScaling

public VkSurfacePresentScalingCapabilitiesKHR supportedPresentScaling(@NativeType("VkPresentScalingFlagsKHR")
 int value)

Sets the specified value to the supportedPresentScaling field.

supportedPresentGravityX

public VkSurfacePresentScalingCapabilitiesKHR supportedPresentGravityX(@NativeType("VkPresentGravityFlagsKHR")
 int value)

Sets the specified value to the supportedPresentGravityX field.

supportedPresentGravityY

public VkSurfacePresentScalingCapabilitiesKHR supportedPresentGravityY(@NativeType("VkPresentGravityFlagsKHR")
 int value)

Sets the specified value to the supportedPresentGravityY field.

minScaledImageExtent

public VkSurfacePresentScalingCapabilitiesKHR minScaledImageExtent(VkExtent2D value)

Copies the specified VkExtent2D to the minScaledImageExtent field.

minScaledImageExtent

public VkSurfacePresentScalingCapabilitiesKHR minScaledImageExtent(Consumer<VkExtent2D> consumer)

Passes the minScaledImageExtent field to the specified Consumer.

maxScaledImageExtent

public VkSurfacePresentScalingCapabilitiesKHR maxScaledImageExtent(VkExtent2D value)

Copies the specified VkExtent2D to the maxScaledImageExtent field.

maxScaledImageExtent

public VkSurfacePresentScalingCapabilitiesKHR maxScaledImageExtent(Consumer<VkExtent2D> consumer)

Passes the maxScaledImageExtent field to the specified Consumer.

set

public VkSurfacePresentScalingCapabilitiesKHR set(int sType,
 long pNext,
 int supportedPresentScaling,
 int supportedPresentGravityX,
 int supportedPresentGravityY,
 VkExtent2D minScaledImageExtent,
 VkExtent2D maxScaledImageExtent)

Initializes this struct with the specified values.

set

public VkSurfacePresentScalingCapabilitiesKHR set(VkSurfacePresentScalingCapabilitiesKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkSurfacePresentScalingCapabilitiesKHR malloc()

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

calloc

public static VkSurfacePresentScalingCapabilitiesKHR calloc()

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

create

public static VkSurfacePresentScalingCapabilitiesKHR create()

Returns a new VkSurfacePresentScalingCapabilitiesKHR instance allocated with BufferUtils.

create

public static VkSurfacePresentScalingCapabilitiesKHR create(long address)

Returns a new VkSurfacePresentScalingCapabilitiesKHR instance for the specified memory address.

createSafe

public static @Nullable VkSurfacePresentScalingCapabilitiesKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkSurfacePresentScalingCapabilitiesKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkSurfacePresentScalingCapabilitiesKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkSurfacePresentScalingCapabilitiesKHR.Buffer create(int capacity)

Returns a new VkSurfacePresentScalingCapabilitiesKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkSurfacePresentScalingCapabilitiesKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkSurfacePresentScalingCapabilitiesKHR malloc(MemoryStack stack)

Returns a new VkSurfacePresentScalingCapabilitiesKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkSurfacePresentScalingCapabilitiesKHR calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsupportedPresentScaling

public static int nsupportedPresentScaling(long struct)

Unsafe version of supportedPresentScaling().

nsupportedPresentGravityX

public static int nsupportedPresentGravityX(long struct)

Unsafe version of supportedPresentGravityX().

nsupportedPresentGravityY

public static int nsupportedPresentGravityY(long struct)

Unsafe version of supportedPresentGravityY().

nminScaledImageExtent

public static VkExtent2D nminScaledImageExtent(long struct)

Unsafe version of minScaledImageExtent().

nmaxScaledImageExtent

public static VkExtent2D nmaxScaledImageExtent(long struct)

Unsafe version of maxScaledImageExtent().

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.

nsupportedPresentScaling

public static void nsupportedPresentScaling(long struct,
 int value)

Unsafe version of supportedPresentScaling.

nsupportedPresentGravityX

public static void nsupportedPresentGravityX(long struct,
 int value)

Unsafe version of supportedPresentGravityX.

nsupportedPresentGravityY

public static void nsupportedPresentGravityY(long struct,
 int value)

Unsafe version of supportedPresentGravityY.

nminScaledImageExtent

public static void nminScaledImageExtent(long struct,
 VkExtent2D value)

Unsafe version of minScaledImageExtent.

nmaxScaledImageExtent

public static void nmaxScaledImageExtent(long struct,
 VkExtent2D value)

Unsafe version of maxScaledImageExtent.