Package org.lwjgl.vulkan
Class VkPipelineViewportStateCreateInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkPipelineViewportStateCreateInfo
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkPipelineViewportStateCreateInfo extends Struct
Khronos Reference Page
Vulkan SpecificationContains information about viewports as part of graphics pipeline creation.
Valid Usage
sTypemust beSTRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFOpNextmust beNULLflagsmust be 0viewportCountmust be greater than 0scissorCountmust be greater than 0- If the multiple viewports feature is not enabled,
viewportCountmust be 1 - If the multiple viewports feature is not enabled,
scissorCountmust be 1 viewportCountmust be between 1 andVkPhysicalDeviceLimits::maxViewports, inclusivescissorCountmust be between 1 andVkPhysicalDeviceLimits::maxViewports, inclusivescissorCountandviewportCountmust be identical
Member documentation
sType– the type of this structure. Must be:STRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFOpNext– reserved for use by extensionsflags– reserved for future useviewportCount– the number of viewports used by the pipelinepViewports– a pointer to an array ofVkViewportstructs, defining the viewport transforms. If the viewport state is dynamic, this member is ignored.scissorCount– the number of scissors and must match the number of viewportspScissors– a pointer to an array ofVkRect2Dstructs which define the rectangular bounds of the scissor for the corresponding viewport. If the scissor state is dynamic, this member is ignored.
Layout
struct VkPipelineViewportStateCreateInfo { VkStructureType sType; const void * pNext; VkPipelineViewportStateCreateFlags flags; uint32_t viewportCount; const VkViewport * pViewports; uint32_t scissorCount; const VkRect2D * pScissors; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classVkPipelineViewportStateCreateInfo.BufferAn array ofVkPipelineViewportStateCreateInfostructs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static intSIZEOFThe struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and Description VkPipelineViewportStateCreateInfo(java.nio.ByteBuffer container)Creates aVkPipelineViewportStateCreateInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static VkPipelineViewportStateCreateInfocalloc()Returns a newVkPipelineViewportStateCreateInfoinstance allocated withmemCalloc.static VkPipelineViewportStateCreateInfo.Buffercalloc(int capacity)Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated withmemCalloc.static VkPipelineViewportStateCreateInfocallocStack()Returns a newVkPipelineViewportStateCreateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkPipelineViewportStateCreateInfo.BuffercallocStack(int capacity)Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkPipelineViewportStateCreateInfo.BuffercallocStack(int capacity, MemoryStack stack)Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPipelineViewportStateCreateInfocallocStack(MemoryStack stack)Returns a newVkPipelineViewportStateCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPipelineViewportStateCreateInfocreate()Returns a newVkPipelineViewportStateCreateInfoinstance allocated withBufferUtils.static VkPipelineViewportStateCreateInfo.Buffercreate(int capacity)Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated withBufferUtils.static VkPipelineViewportStateCreateInfocreate(long address)Returns a newVkPipelineViewportStateCreateInfoinstance for the specified memory address ornullif the address isNULL.static VkPipelineViewportStateCreateInfo.Buffercreate(long address, int capacity)Create aVkPipelineViewportStateCreateInfo.Bufferinstance at the specified memory.intflags()Returns the value of theflagsfield.VkPipelineViewportStateCreateInfoflags(int value)Sets the specified value to theflagsfield.static VkPipelineViewportStateCreateInfomalloc()Returns a newVkPipelineViewportStateCreateInfoinstance allocated withmemAlloc.static VkPipelineViewportStateCreateInfo.Buffermalloc(int capacity)Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated withmemAlloc.static VkPipelineViewportStateCreateInfomallocStack()Returns a newVkPipelineViewportStateCreateInfoinstance allocated on the thread-localMemoryStack.static VkPipelineViewportStateCreateInfo.BuffermallocStack(int capacity)Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated on the thread-localMemoryStack.static VkPipelineViewportStateCreateInfo.BuffermallocStack(int capacity, MemoryStack stack)Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkPipelineViewportStateCreateInfomallocStack(MemoryStack stack)Returns a newVkPipelineViewportStateCreateInfoinstance allocated on the specifiedMemoryStack.VkPipelineViewportStateCreateInfonset(long struct)Unsafe version ofset.longpNext()Returns the value of thepNextfield.VkPipelineViewportStateCreateInfopNext(long value)Sets the specified value to thepNextfield.VkRect2D.BufferpScissors()Returns aVkRect2D.Bufferview of the struct array pointed to by thepScissorsfield.VkPipelineViewportStateCreateInfopScissors(VkRect2D.Buffer value)Sets the address of the specifiedVkRect2D.Bufferto thepScissorsfield.VkViewport.BufferpViewports()Returns aVkViewport.Bufferview of the struct array pointed to by thepViewportsfield.VkPipelineViewportStateCreateInfopViewports(VkViewport.Buffer value)Sets the address of the specifiedVkViewport.Bufferto thepViewportsfield.intscissorCount()Returns the value of thescissorCountfield.VkPipelineViewportStateCreateInfoscissorCount(int value)Sets the specified value to thescissorCountfield.VkPipelineViewportStateCreateInfoset(int sType, long pNext, int flags, int viewportCount, VkViewport.Buffer pViewports, int scissorCount, VkRect2D.Buffer pScissors)Initializes this struct with the specified values.VkPipelineViewportStateCreateInfoset(VkPipelineViewportStateCreateInfo src)Copies the specified struct data to this struct.intsizeof()Returns thesizeof(struct).intsType()Returns the value of thesTypefield.VkPipelineViewportStateCreateInfosType(int value)Sets the specified value to thesTypefield.intviewportCount()Returns the value of theviewportCountfield.VkPipelineViewportStateCreateInfoviewportCount(int value)Sets the specified value to theviewportCountfield.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkPipelineViewportStateCreateInfo
public VkPipelineViewportStateCreateInfo(java.nio.ByteBuffer container)
Creates aVkPipelineViewportStateCreateInfoinstance at the current position of the specifiedByteBuffercontainer. 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:StructReturns thesizeof(struct).
-
sType
public int sType()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
flags
public int flags()
Returns the value of theflagsfield.
-
viewportCount
public int viewportCount()
Returns the value of theviewportCountfield.
-
pViewports
public VkViewport.Buffer pViewports()
Returns aVkViewport.Bufferview of the struct array pointed to by thepViewportsfield.
-
scissorCount
public int scissorCount()
Returns the value of thescissorCountfield.
-
pScissors
public VkRect2D.Buffer pScissors()
Returns aVkRect2D.Bufferview of the struct array pointed to by thepScissorsfield.
-
sType
public VkPipelineViewportStateCreateInfo sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkPipelineViewportStateCreateInfo pNext(long value)
Sets the specified value to thepNextfield.
-
flags
public VkPipelineViewportStateCreateInfo flags(int value)
Sets the specified value to theflagsfield.
-
viewportCount
public VkPipelineViewportStateCreateInfo viewportCount(int value)
Sets the specified value to theviewportCountfield.
-
pViewports
public VkPipelineViewportStateCreateInfo pViewports(VkViewport.Buffer value)
Sets the address of the specifiedVkViewport.Bufferto thepViewportsfield.
-
scissorCount
public VkPipelineViewportStateCreateInfo scissorCount(int value)
Sets the specified value to thescissorCountfield.
-
pScissors
public VkPipelineViewportStateCreateInfo pScissors(VkRect2D.Buffer value)
Sets the address of the specifiedVkRect2D.Bufferto thepScissorsfield.
-
set
public VkPipelineViewportStateCreateInfo set(int sType, long pNext, int flags, int viewportCount, VkViewport.Buffer pViewports, int scissorCount, VkRect2D.Buffer pScissors)
Initializes this struct with the specified values.
-
nset
public VkPipelineViewportStateCreateInfo nset(long struct)
Unsafe version ofset.
-
set
public VkPipelineViewportStateCreateInfo set(VkPipelineViewportStateCreateInfo src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkPipelineViewportStateCreateInfo malloc()
Returns a newVkPipelineViewportStateCreateInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkPipelineViewportStateCreateInfo calloc()
Returns a newVkPipelineViewportStateCreateInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkPipelineViewportStateCreateInfo create()
Returns a newVkPipelineViewportStateCreateInfoinstance allocated withBufferUtils.
-
create
public static VkPipelineViewportStateCreateInfo create(long address)
Returns a newVkPipelineViewportStateCreateInfoinstance for the specified memory address ornullif the address isNULL.
-
malloc
public static VkPipelineViewportStateCreateInfo.Buffer malloc(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkPipelineViewportStateCreateInfo.Buffer calloc(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkPipelineViewportStateCreateInfo.Buffer create(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkPipelineViewportStateCreateInfo.Buffer create(long address, int capacity)
Create aVkPipelineViewportStateCreateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
mallocStack
public static VkPipelineViewportStateCreateInfo mallocStack()
Returns a newVkPipelineViewportStateCreateInfoinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkPipelineViewportStateCreateInfo callocStack()
Returns a newVkPipelineViewportStateCreateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkPipelineViewportStateCreateInfo mallocStack(MemoryStack stack)
Returns a newVkPipelineViewportStateCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkPipelineViewportStateCreateInfo callocStack(MemoryStack stack)
Returns a newVkPipelineViewportStateCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkPipelineViewportStateCreateInfo.Buffer mallocStack(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkPipelineViewportStateCreateInfo.Buffer callocStack(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkPipelineViewportStateCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkPipelineViewportStateCreateInfo.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkPipelineViewportStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
-