Header menu logo Nu

Sprite Module

Functions and values

Function or value Description

Sprite.CreateSpriteQuad onlyUpperRightQuadrant

Full Usage: Sprite.CreateSpriteQuad onlyUpperRightQuadrant

Parameters:
    onlyUpperRightQuadrant : bool

Returns: uint32 * uint32

Create a sprite quad for rendering to a shader matching the one created with Hl.CreateSpriteShader.

onlyUpperRightQuadrant : bool
Returns: uint32 * uint32

Sprite.CreateSpriteShader shaderFilePath

Full Usage: Sprite.CreateSpriteShader shaderFilePath

Parameters:
    shaderFilePath : string

Returns: int * int * int * int * uint32

Create a sprite shader.

shaderFilePath : string
Returns: int * int * int * int * uint32

Sprite.CreateSpriteVao ()

Full Usage: Sprite.CreateSpriteVao ()

Parameters:
    () : unit

Returns: uint32
() : unit
Returns: uint32

Sprite.DrawSprite (vertices, indices, viewProjection, modelViewProjection, insetOpt, clipOpt, color, flip, textureWidth, textureHeight, texture, viewport, modelViewProjectionUniform, texCoords4Uniform, colorUniform, textureUniform, shader, vao)

Full Usage: Sprite.DrawSprite (vertices, indices, viewProjection, modelViewProjection, insetOpt, clipOpt, color, flip, textureWidth, textureHeight, texture, viewport, modelViewProjectionUniform, texCoords4Uniform, colorUniform, textureUniform, shader, vao)

Parameters:
    vertices : uint32
    indices : uint32
    viewProjection : inref<Matrix4x4>
    modelViewProjection : single array
    insetOpt : inref<Box2 voption>
    clipOpt : inref<Box2 voption>
    color : inref<Color>
    flip : Flip
    textureWidth : int
    textureHeight : int
    texture : Texture
    viewport : Viewport
    modelViewProjectionUniform : int
    texCoords4Uniform : int
    colorUniform : int
    textureUniform : int
    shader : uint32
    vao : uint32

Draw a sprite whose indices and vertices were created by Gl.CreateSpriteQuad and whose uniforms and shader match those of CreateSpriteShader.

vertices : uint32
indices : uint32
viewProjection : inref<Matrix4x4>
modelViewProjection : single array
insetOpt : inref<Box2 voption>
clipOpt : inref<Box2 voption>
color : inref<Color>
flip : Flip
textureWidth : int
textureHeight : int
texture : Texture
viewport : Viewport
modelViewProjectionUniform : int
texCoords4Uniform : int
colorUniform : int
textureUniform : int
shader : uint32
vao : uint32

Sprite.VertexSize

Full Usage: Sprite.VertexSize

Returns: int
Returns: int

Type something to start searching.