Lysa.ui  0.0
Lysa 3D Engine
Image Class Referenceabstract

Detailed Description

A widget that displays a GPU image with an optional color tint.

Inherits from: Widget

Lua full name: lysa.ui.Image

Public Member Functions

nil set_auto_size (autoSize: boolean)
 When true, the widget automatically resizes itself to match the displayed image's pixel dimensions. More...
 
nil set_image (image: lysa.Image)
 Sets the displayed image from an existing GPU Image object. More...
 
nil set_image (uri: string)
 Loads and sets the displayed image from the given virtual URI. More...
 

Properties

lysa.float4 color
 RGBA color tint multiplied with the image pixels (default white = no tint).
 
lysa.Image image
 The GPU image currently displayed, or nil if none is set. (read-only)
 

Member Function Documentation

nil set_auto_size ( boolean  autoSize)

When true, the widget automatically resizes itself to match the displayed image's pixel dimensions.

Parameters
autoSizeboolean
nil set_image ( lysa.Image  image)

Sets the displayed image from an existing GPU Image object.

Parameters
imagelysa.Image
nil set_image ( string  uri)

Loads and sets the displayed image from the given virtual URI.

Parameters
uristring

Property Documentation

lysa.float4 color

RGBA color tint multiplied with the image pixels (default white = no tint).

lysa.Image image

The GPU image currently displayed, or nil if none is set. (read-only)