Header menu logo Nu

SpriteSingleton Module

Single sprite operations.

Functions and values

Function or value Description

SpriteSingleton.VertexSize

Full Usage: SpriteSingleton.VertexSize

Returns: int

The size of a vertex in the sprite singleton pipeline.

Returns: int

SpriteSingleton.createSpriteQuad onlyUpperRightQuadrant context

Full Usage: SpriteSingleton.createSpriteQuad onlyUpperRightQuadrant context

Parameters:
Returns: VulkanBuffer * VulkanBuffer

Create a sprite singleton quad for rendering to this pipeline.

onlyUpperRightQuadrant : bool
context : VulkanContext
Returns: VulkanBuffer * VulkanBuffer

SpriteSingleton.createSpriteSingletonPipeline resolveTextureFormat context

Full Usage: SpriteSingleton.createSpriteSingletonPipeline resolveTextureFormat context

Parameters:
Returns: VulkanBuffer * VulkanBuffer * Pipeline

Create a sprite singleton pipeline.

resolveTextureFormat : VkFormat
context : VulkanContext
Returns: VulkanBuffer * VulkanBuffer * Pipeline

SpriteSingleton.drawSpriteSingleton (vertices, indices, absolute, viewProjectionClipAbsolute, viewProjectionClipRelative, modelViewProjection, insetOpt, clipOpt, color, flip, textureWidth, textureHeight, texture, sampler, viewport, resolveTexture, spriteVertUniform, spriteFragUniform, pipeline, context)

Full Usage: SpriteSingleton.drawSpriteSingleton (vertices, indices, absolute, viewProjectionClipAbsolute, viewProjectionClipRelative, modelViewProjection, insetOpt, clipOpt, color, flip, textureWidth, textureHeight, texture, sampler, viewport, resolveTexture, spriteVertUniform, spriteFragUniform, pipeline, context)

Parameters:

Draw a single sprite.

vertices : VulkanBuffer
indices : VulkanBuffer
absolute : bool
viewProjectionClipAbsolute : inref<Matrix4x4>
viewProjectionClipRelative : inref<Matrix4x4>
modelViewProjection : Matrix4x4
insetOpt : inref<Box2 voption>
clipOpt : inref<Box2 voption>
color : inref<Color>
flip : Flip
textureWidth : int
textureHeight : int
texture : Texture
sampler : Sampler
viewport : Viewport
resolveTexture : Texture
spriteVertUniform : VulkanBuffer
spriteFragUniform : VulkanBuffer
pipeline : Pipeline
context : VulkanContext

Type something to start searching.