LoadSprite

This function loads a texture, creates a sprite with the dimensions of the texture image, and applies the texture to the sprite material.

Syntax

• Sprite LoadSprite(World world, WString path, number flags = LOAD_DEFAULT)
• Sprite LoadSprite(World world, Stream stream, number flags = LOAD_DEFAULT)

Returns

If the texture is successfully loaded a new sprite is returned, otherwise NULL is returned.

Example

-- Get the displays
local displays = GetDisplays()

-- Create a window
local window = CreateWindow("Ultra Engine", 0, 0, 1280, 720, displays[1], WINDOW_CENTER | WINDOW_TITLEBAR)

-- Create framebuffer
local framebuffer = CreateFramebuffer(window)

-- Create world
local world = CreateWorld()

-- Create camera
local camera = CreateCamera(world, PROJECTION_ORTHOGRAPHIC)
camera:SetClearColor(0.125)

-- Create sprite
local sprite = LoadSprite(world, "https://raw.githubusercontent.com/UltraEngine/Documentation/master/Assets/Materials/Sprites/nightraider.dds")
sprite:SetPosition(-sprite.size.x * 0.5, -sprite.size.y * 0.5, 0)
sprite.mesh.material:SetAlphaMask(true)

-- Main loop
while (not window:Closed()) and (not window:KeyHit(KEY_ESCAPE)) do
    world:Update()
    world:Render(framebuffer)
end