Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkSwapchainPresentScalingCreateInfoEXT

extends Struct<VkSwapchainPresentScalingCreateInfoEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Scaling behavior when presenting to the surface.
Description

If scalingBehavior is 0, the result of presenting a swapchain image with dimensions that do not match the surface dimensions is implementation and platform-dependent. If presentGravityX or presentGravityY are 0, the presentation gravity must match that defined by the native platform surface on platforms which define surface gravity.

Valid Usage
Valid Usage (Implicit)

Layout


struct VkSwapchainPresentScalingCreateInfoEXT {
    VkStructureType sType;
    void const * pNext;
    VkPresentScalingFlagsEXT scalingBehavior;
    VkPresentGravityFlagsEXT presentGravityX;
    VkPresentGravityFlagsEXT presentGravityY;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
PNEXT

The struct member offsets.

public static final int
PRESENTGRAVITYX

The struct member offsets.

public static final int
PRESENTGRAVITYY

The struct member offsets.

public static final int
SCALINGBEHAVIOR

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkSwapchainPresentScalingCreateInfoEXT(ByteBuffer container)

Creates a VkSwapchainPresentScalingCreateInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkSwapchainPresentScalingCreateInfoEXT
calloc()

Returns a new VkSwapchainPresentScalingCreateInfoEXT instance allocated with memCalloc.

public static VkSwapchainPresentScalingCreateInfoEXT.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkSwapchainPresentScalingCreateInfoEXT.Buffer instance allocated with memCalloc.

public static VkSwapchainPresentScalingCreateInfoEXT
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkSwapchainPresentScalingCreateInfoEXT.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

protected VkSwapchainPresentScalingCreateInfoEXT
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkSwapchainPresentScalingCreateInfoEXT
create()

Returns a new VkSwapchainPresentScalingCreateInfoEXT instance allocated with BufferUtils.

public static VkSwapchainPresentScalingCreateInfoEXT
create(long address)

Returns a new VkSwapchainPresentScalingCreateInfoEXT instance for the specified memory address.

public static VkSwapchainPresentScalingCreateInfoEXT.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkSwapchainPresentScalingCreateInfoEXT.Buffer instance allocated with BufferUtils.

public static VkSwapchainPresentScalingCreateInfoEXT.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkSwapchainPresentScalingCreateInfoEXT.Buffer instance at the specified memory.

public static VkSwapchainPresentScalingCreateInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkSwapchainPresentScalingCreateInfoEXT.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static VkSwapchainPresentScalingCreateInfoEXT
malloc()

Returns a new VkSwapchainPresentScalingCreateInfoEXT instance allocated with memAlloc.

public static VkSwapchainPresentScalingCreateInfoEXT.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkSwapchainPresentScalingCreateInfoEXT.Buffer instance allocated with memAlloc.

public static VkSwapchainPresentScalingCreateInfoEXT
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkSwapchainPresentScalingCreateInfoEXT instance allocated on the specified MemoryStack.

public static VkSwapchainPresentScalingCreateInfoEXT.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
npresentGravityX(long struct)

Unsafe version of presentGravityX.

public static void
npresentGravityX(long struct, int value)

Unsafe version of presentGravityX.

public static int
npresentGravityY(long struct)

Unsafe version of presentGravityY.

public static void
npresentGravityY(long struct, int value)

Unsafe version of presentGravityY.

public static int
nscalingBehavior(long struct)

Unsafe version of scalingBehavior.

public static void
nscalingBehavior(long struct, int value)

Unsafe version of scalingBehavior.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkSwapchainPresentScalingCreateInfoEXT
pNext(long value)

Sets the specified value to the pNext field.

public int
presentGravityX()

0 or the x-axis direction in which swapchain image pixels gravitate relative to the surface when scalingBehavior does not result in a one-to-one pixel mapping between the scaled swapchain image and the surface.

public VkSwapchainPresentScalingCreateInfoEXT
presentGravityX(int value)

Sets the specified value to the presentGravityX field.

public int
presentGravityY()

0 or the y-axis direction in which swapchain image pixels gravitate relative to the surface when scalingBehavior does not result in a one-to-one pixel mapping between the scaled swapchain image and the surface.

public VkSwapchainPresentScalingCreateInfoEXT
presentGravityY(int value)

Sets the specified value to the presentGravityY field.

public int
scalingBehavior()

0 or the scaling method to use when the dimensions of the surface and swapchain images differ.

public VkSwapchainPresentScalingCreateInfoEXT
scalingBehavior(int value)

Sets the specified value to the scalingBehavior field.

public VkSwapchainPresentScalingCreateInfoEXT
set(int sType, long pNext, int scalingBehavior, int presentGravityX, int presentGravityY)

Initializes this struct with the specified values.

public VkSwapchainPresentScalingCreateInfoEXT

Returns:

this struct
set
(VkSwapchainPresentScalingCreateInfoEXT
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkSwapchainPresentScalingCreateInfoEXT
sType(int value)

Sets the specified value to the sType field.

public VkSwapchainPresentScalingCreateInfoEXT
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

PRESENTGRAVITYXback to summary
public static final int PRESENTGRAVITYX

The struct member offsets.

PRESENTGRAVITYYback to summary
public static final int PRESENTGRAVITYY

The struct member offsets.

SCALINGBEHAVIORback to summary
public static final int SCALINGBEHAVIOR

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkSwapchainPresentScalingCreateInfoEXTback to summary
protected VkSwapchainPresentScalingCreateInfoEXT(long address, ByteBuffer container)
VkSwapchainPresentScalingCreateInfoEXTback to summary
public VkSwapchainPresentScalingCreateInfoEXT(ByteBuffer container)

Creates a VkSwapchainPresentScalingCreateInfoEXT 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 Detail

callocback to summary
public static VkSwapchainPresentScalingCreateInfoEXT calloc()

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

callocback to summary
public static VkSwapchainPresentScalingCreateInfoEXT.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkSwapchainPresentScalingCreateInfoEXT calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkSwapchainPresentScalingCreateInfoEXT.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected VkSwapchainPresentScalingCreateInfoEXT create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkSwapchainPresentScalingCreateInfoEXT create()

Returns a new VkSwapchainPresentScalingCreateInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkSwapchainPresentScalingCreateInfoEXT create(long address)

Returns a new VkSwapchainPresentScalingCreateInfoEXT instance for the specified memory address.

createback to summary
public static VkSwapchainPresentScalingCreateInfoEXT.Buffer create(int capacity)

Returns a new VkSwapchainPresentScalingCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkSwapchainPresentScalingCreateInfoEXT.Buffer create(long address, int capacity)

Create a VkSwapchainPresentScalingCreateInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkSwapchainPresentScalingCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkSwapchainPresentScalingCreateInfoEXT.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkSwapchainPresentScalingCreateInfoEXT malloc()

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

mallocback to summary
public static VkSwapchainPresentScalingCreateInfoEXT.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkSwapchainPresentScalingCreateInfoEXT malloc(MemoryStack stack)

Returns a new VkSwapchainPresentScalingCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkSwapchainPresentScalingCreateInfoEXT.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

npresentGravityXback to summary
public static int npresentGravityX(long struct)

Unsafe version of presentGravityX.

npresentGravityXback to summary
public static void npresentGravityX(long struct, int value)

Unsafe version of presentGravityX.

npresentGravityYback to summary
public static int npresentGravityY(long struct)

Unsafe version of presentGravityY.

npresentGravityYback to summary
public static void npresentGravityY(long struct, int value)

Unsafe version of presentGravityY.

nscalingBehaviorback to summary
public static int nscalingBehavior(long struct)

Unsafe version of scalingBehavior.

nscalingBehaviorback to summary
public static void nscalingBehavior(long struct, int value)

Unsafe version of scalingBehavior.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkSwapchainPresentScalingCreateInfoEXT pNext(long value)

Sets the specified value to the pNext field.

presentGravityXback to summary
public int presentGravityX()

0 or the x-axis direction in which swapchain image pixels gravitate relative to the surface when scalingBehavior does not result in a one-to-one pixel mapping between the scaled swapchain image and the surface.

Annotations
@NativeType:VkPresentGravityFlagsEXT
presentGravityXback to summary
public VkSwapchainPresentScalingCreateInfoEXT presentGravityX(int value)

Sets the specified value to the presentGravityX field.

presentGravityYback to summary
public int presentGravityY()

0 or the y-axis direction in which swapchain image pixels gravitate relative to the surface when scalingBehavior does not result in a one-to-one pixel mapping between the scaled swapchain image and the surface.

Annotations
@NativeType:VkPresentGravityFlagsEXT
presentGravityYback to summary
public VkSwapchainPresentScalingCreateInfoEXT presentGravityY(int value)

Sets the specified value to the presentGravityY field.

scalingBehaviorback to summary
public int scalingBehavior()

0 or the scaling method to use when the dimensions of the surface and swapchain images differ.

Annotations
@NativeType:VkPresentScalingFlagsEXT
scalingBehaviorback to summary
public VkSwapchainPresentScalingCreateInfoEXT scalingBehavior(int value)

Sets the specified value to the scalingBehavior field.

setback to summary
public VkSwapchainPresentScalingCreateInfoEXT set(int sType, long pNext, int scalingBehavior, int presentGravityX, int presentGravityY)

Initializes this struct with the specified values.

setback to summary
public VkSwapchainPresentScalingCreateInfoEXT set(VkSwapchainPresentScalingCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkSwapchainPresentScalingCreateInfoEXT

the source struct

Returns:VkSwapchainPresentScalingCreateInfoEXT

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkSwapchainPresentScalingCreateInfoEXT sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkSwapchainPresentScalingCreateInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_SWAPCHAIN_PRESENT_SCALING_CREATE_INFO_EXT value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkSwapchainPresentScalingCreateInfoEXT.Buffer

extends StructBuffer<VkSwapchainPresentScalingCreateInfoEXT, VkSwapchainPresentScalingCreateInfoEXT.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkSwapchainPresentScalingCreateInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkSwapchainPresentScalingCreateInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkSwapchainPresentScalingCreateInfoEXT.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VkSwapchainPresentScalingCreateInfoEXT
public long

Returns:

the value of the VkSwapchainPresentScalingCreateInfoEXT#pNext field.
pNext
()

public VkSwapchainPresentScalingCreateInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkSwapchainPresentScalingCreateInfoEXT#pNext field.

public int
public VkSwapchainPresentScalingCreateInfoEXT.Buffer
presentGravityX(int value)

Sets the specified value to the VkSwapchainPresentScalingCreateInfoEXT#presentGravityX field.

public int
public VkSwapchainPresentScalingCreateInfoEXT.Buffer
presentGravityY(int value)

Sets the specified value to the VkSwapchainPresentScalingCreateInfoEXT#presentGravityY field.

public int
public VkSwapchainPresentScalingCreateInfoEXT.Buffer
scalingBehavior(int value)

Sets the specified value to the VkSwapchainPresentScalingCreateInfoEXT#scalingBehavior field.

protected VkSwapchainPresentScalingCreateInfoEXT.Buffer
public int

Returns:

the value of the VkSwapchainPresentScalingCreateInfoEXT#sType field.
sType
()

public VkSwapchainPresentScalingCreateInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkSwapchainPresentScalingCreateInfoEXT#sType field.

public VkSwapchainPresentScalingCreateInfoEXT.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkSwapchainPresentScalingCreateInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkSwapchainPresentScalingCreateInfoEXT.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkSwapchainPresentScalingCreateInfoEXT#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VkSwapchainPresentScalingCreateInfoEXT getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkSwapchainPresentScalingCreateInfoEXT#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkSwapchainPresentScalingCreateInfoEXT.Buffer pNext(long value)

Sets the specified value to the VkSwapchainPresentScalingCreateInfoEXT#pNext field.

presentGravityXback to summary
public int presentGravityX()
Returns:int

the value of the VkSwapchainPresentScalingCreateInfoEXT#presentGravityX field.

Annotations
@NativeType:VkPresentGravityFlagsEXT
presentGravityXback to summary
public VkSwapchainPresentScalingCreateInfoEXT.Buffer presentGravityX(int value)

Sets the specified value to the VkSwapchainPresentScalingCreateInfoEXT#presentGravityX field.

presentGravityYback to summary
public int presentGravityY()
Returns:int

the value of the VkSwapchainPresentScalingCreateInfoEXT#presentGravityY field.

Annotations
@NativeType:VkPresentGravityFlagsEXT
presentGravityYback to summary
public VkSwapchainPresentScalingCreateInfoEXT.Buffer presentGravityY(int value)

Sets the specified value to the VkSwapchainPresentScalingCreateInfoEXT#presentGravityY field.

scalingBehaviorback to summary
public int scalingBehavior()
Returns:int

the value of the VkSwapchainPresentScalingCreateInfoEXT#scalingBehavior field.

Annotations
@NativeType:VkPresentScalingFlagsEXT
scalingBehaviorback to summary
public VkSwapchainPresentScalingCreateInfoEXT.Buffer scalingBehavior(int value)

Sets the specified value to the VkSwapchainPresentScalingCreateInfoEXT#scalingBehavior field.

selfback to summary
protected VkSwapchainPresentScalingCreateInfoEXT.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkSwapchainPresentScalingCreateInfoEXT#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkSwapchainPresentScalingCreateInfoEXT.Buffer sType(int value)

Sets the specified value to the VkSwapchainPresentScalingCreateInfoEXT#sType field.

sType$Defaultback to summary
public VkSwapchainPresentScalingCreateInfoEXT.Buffer sType$Default()

Sets the STRUCTURE_TYPE_SWAPCHAIN_PRESENT_SCALING_CREATE_INFO_EXT value to the VkSwapchainPresentScalingCreateInfoEXT#sType field.