Package org.lwjgl.vulkan
Class VkViewport
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkViewport
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkViewport extends Struct
Khronos Reference Page
Vulkan SpecificationDescribes viewport transformation parameters.
Valid Usage
width
must be greater than0.0
and less than or equal toVkPhysicalDeviceLimits
::maxViewportDimensions
[0]height
must be greater than0.0
and less than or equal toVkPhysicalDeviceLimits
::maxViewportDimensions
[1]x
andy
must each be betweenviewportBoundsRange
[0] andviewportBoundsRange
[1], inclusivex
+width
must be less than or equal toviewportBoundsRange
[1]y
+height
must be less than or equal toviewportBoundsRange
[1]minDepth
must be between0.0
and1.0
, inclusivemaxDepth
must be between0.0
and1.0
, inclusive
Member documentation
x
– the viewport's left boundy
– the viewport's upper boundwidth
– the viewport's widthheight
– the viewport's heightminDepth
– the minimum viewport depthmaxDepth
– the maximum viewport depth
Layout
struct VkViewport { float x; float y; float width; float height; float minDepth; float maxDepth; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkViewport.Buffer
An array ofVkViewport
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and Description VkViewport(java.nio.ByteBuffer container)
Creates aVkViewport
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static VkViewport
calloc()
Returns a newVkViewport
instance allocated withmemCalloc
.static VkViewport.Buffer
calloc(int capacity)
Returns a newVkViewport.Buffer
instance allocated withmemCalloc
.static VkViewport
callocStack()
Returns a newVkViewport
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkViewport.Buffer
callocStack(int capacity)
Returns a newVkViewport.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkViewport.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkViewport.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkViewport
callocStack(MemoryStack stack)
Returns a newVkViewport
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkViewport
create()
Returns a newVkViewport
instance allocated withBufferUtils
.static VkViewport.Buffer
create(int capacity)
Returns a newVkViewport.Buffer
instance allocated withBufferUtils
.static VkViewport
create(long address)
static VkViewport.Buffer
create(long address, int capacity)
Create aVkViewport.Buffer
instance at the specified memory.float
height()
Returns the value of theheight
field.VkViewport
height(float value)
Sets the specified value to theheight
field.static VkViewport
malloc()
Returns a newVkViewport
instance allocated withmemAlloc
.static VkViewport.Buffer
malloc(int capacity)
Returns a newVkViewport.Buffer
instance allocated withmemAlloc
.static VkViewport
mallocStack()
Returns a newVkViewport
instance allocated on the thread-localMemoryStack
.static VkViewport.Buffer
mallocStack(int capacity)
Returns a newVkViewport.Buffer
instance allocated on the thread-localMemoryStack
.static VkViewport.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkViewport.Buffer
instance allocated on the specifiedMemoryStack
.static VkViewport
mallocStack(MemoryStack stack)
Returns a newVkViewport
instance allocated on the specifiedMemoryStack
.float
maxDepth()
Returns the value of themaxDepth
field.VkViewport
maxDepth(float value)
Sets the specified value to themaxDepth
field.float
minDepth()
Returns the value of theminDepth
field.VkViewport
minDepth(float value)
Sets the specified value to theminDepth
field.VkViewport
nset(long struct)
Unsafe version ofset
.VkViewport
set(float x, float y, float width, float height, float minDepth, float maxDepth)
Initializes this struct with the specified values.VkViewport
set(VkViewport src)
Copies the specified struct data to this struct.int
sizeof()
Returns thesizeof(struct)
.float
width()
Returns the value of thewidth
field.VkViewport
width(float value)
Sets the specified value to thewidth
field.float
x()
Returns the value of thex
field.VkViewport
x(float value)
Sets the specified value to thex
field.float
y()
Returns the value of they
field.VkViewport
y(float value)
Sets the specified value to they
field.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkViewport
public VkViewport(java.nio.ByteBuffer container)
Creates aVkViewport
instance at the current position of the specifiedByteBuffer
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
-
sizeof
public int sizeof()
Description copied from class:Struct
Returns thesizeof(struct)
.
-
x
public float x()
Returns the value of thex
field.
-
y
public float y()
Returns the value of they
field.
-
width
public float width()
Returns the value of thewidth
field.
-
height
public float height()
Returns the value of theheight
field.
-
minDepth
public float minDepth()
Returns the value of theminDepth
field.
-
maxDepth
public float maxDepth()
Returns the value of themaxDepth
field.
-
x
public VkViewport x(float value)
Sets the specified value to thex
field.
-
y
public VkViewport y(float value)
Sets the specified value to they
field.
-
width
public VkViewport width(float value)
Sets the specified value to thewidth
field.
-
height
public VkViewport height(float value)
Sets the specified value to theheight
field.
-
minDepth
public VkViewport minDepth(float value)
Sets the specified value to theminDepth
field.
-
maxDepth
public VkViewport maxDepth(float value)
Sets the specified value to themaxDepth
field.
-
set
public VkViewport set(float x, float y, float width, float height, float minDepth, float maxDepth)
Initializes this struct with the specified values.
-
nset
public VkViewport nset(long struct)
Unsafe version ofset
.
-
set
public VkViewport set(VkViewport src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkViewport malloc()
Returns a newVkViewport
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkViewport calloc()
Returns a newVkViewport
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkViewport create()
Returns a newVkViewport
instance allocated withBufferUtils
.
-
create
public static VkViewport create(long address)
-
malloc
public static VkViewport.Buffer malloc(int capacity)
Returns a newVkViewport.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkViewport.Buffer calloc(int capacity)
Returns a newVkViewport.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkViewport.Buffer create(int capacity)
Returns a newVkViewport.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkViewport.Buffer create(long address, int capacity)
Create aVkViewport.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkViewport mallocStack()
Returns a newVkViewport
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkViewport callocStack()
Returns a newVkViewport
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkViewport mallocStack(MemoryStack stack)
Returns a newVkViewport
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkViewport callocStack(MemoryStack stack)
Returns a newVkViewport
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkViewport.Buffer mallocStack(int capacity)
Returns a newVkViewport.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkViewport.Buffer callocStack(int capacity)
Returns a newVkViewport.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkViewport.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkViewport.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkViewport.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkViewport.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-