@ -134,7 +134,7 @@ For more details about refreshtype, refreshregion & refreshdither see the descri
If refreshtype is omitted , no refresh will be enqueued at this time .
@ param widget a @ { ui.widget . widget | widget } object
@ string refreshtype ` " full" ` , ` " flashpartial " ` , ` " flashui " ` , ` " [partial] " ` , ` " [ui] " ` , ` " partial " ` , ` " ui " ` , ` " fast " ` , ` " a2 " ` ( optional )
@ string refreshtype ` " color" ` , ` " colortext " ` , ` " full" ` , ` " flashpartial " ` , ` " flashui " ` , ` " [partial] " ` , ` " [ui] " ` , ` " partial " ` , ` " ui " ` , ` " fast " ` , ` " a2 " ` ( optional )
@ param refreshregion a rectangle @ { ui.geometry . Geom | Geom } object ( optional , requires refreshtype to be set )
@ int x horizontal screen offset ( optional , ` 0 ` if omitted )
@ int y vertical screen offset ( optional , ` 0 ` if omitted )
@ -191,7 +191,7 @@ For more details about refreshtype, refreshregion & refreshdither see the descri
If refreshtype is omitted , no extra refresh will be enqueued at this time , leaving only those from the uncovered widgets .
@ param widget a @ { ui.widget . widget | widget } object
@ string refreshtype ` " full" ` , ` " flashpartial " ` , ` " flashui " ` , ` " [partial] " ` , ` " [ui] " ` , ` " partial " ` , ` " ui " ` , ` " fast " ` , ` " a2 " ` ( optional )
@ string refreshtype ` " color" ` , ` " colortext " ` , ` " full" ` , ` " flashpartial " ` , ` " flashui " ` , ` " [partial] " ` , ` " [ui] " ` , ` " partial " ` , ` " ui " ` , ` " fast " ` , ` " a2 " ` ( optional )
@ param refreshregion a rectangle @ { ui.geometry . Geom | Geom } object ( optional , requires refreshtype to be set )
@ bool refreshdither ` true ` if the refresh requires dithering ( optional , requires refreshtype to be set )
@ see setDirty
@ -460,6 +460,10 @@ It just appends stuff to the paint and/or refresh queues.
Here ' s a quick rundown of what each refreshtype should be used for:
* ` color ` : high - fidelity flashing refresh for color image content on Kaleido panels .
Maps to partial on unsupported devices , as such , better used conditionally behind a Device : hasKaleidoWfm check .
* ` colortext ` : REAGL refresh for color text ( e.g . , highlights ) on Kaleido panels .
Maps to partial on unsupported devices , as such , better used conditionally behind a Device : hasKaleidoWfm check .
* ` full ` : high - fidelity flashing refresh ( e.g . , large images ) .
Highest quality , but highest latency .
Don ' t abuse if you only want a flash (in this case, prefer `flashui` or `flashpartial`).
@ -558,7 +562,7 @@ UIManager:setDirty(self.widget, "partial", Geom:new{x=10,y=10,w=100,h=50})
UIManager : setDirty ( self.widget , function ( ) return " ui " , self.someelement . dimen end )
@ param widget a window - level widget object , ` " all " ` , or ` nil `
@ param refreshtype ` " full" ` , ` " flashpartial " ` , ` " flashui " ` , ` " [partial] " ` , ` " [ui] " ` , ` " partial " ` , ` " ui " ` , ` " fast " ` , ` " a2 " ` ( or a lambda , see description above )
@ param refreshtype ` " color" ` , ` " colortext " ` , ` " full" ` , ` " flashpartial " ` , ` " flashui " ` , ` " [partial] " ` , ` " [ui] " ` , ` " partial " ` , ` " ui " ` , ` " fast " ` , ` " a2 " ` ( or a lambda , see description above )
@ param refreshregion a rectangle @ { ui.geometry . Geom | Geom } object ( optional , omitting it means the region will cover the full screen )
@ bool refreshdither ` true ` if widget requires dithering ( optional )
] ]
@ -1050,7 +1054,7 @@ function UIManager:getElapsedTimeSinceBoot()
end
-- precedence of refresh modes:
local refresh_modes = { a2 = 1 , fast = 2 , ui = 3 , partial = 4 , [ " [ui] " ] = 5 , [ " [partial] " ] = 6 , flashui = 7 , flashpartial = 8 , full = 9 }
local refresh_modes = { a2 = 1 , fast = 2 , ui = 3 , partial = 4 , [ " [ui] " ] = 5 , [ " [partial] " ] = 6 , flashui = 7 , flashpartial = 8 , full = 9 , colortext = 10 , color = 11 }
-- NOTE: We might want to introduce a "force_a2" that points to fast, but has the highest priority,
-- for the few cases where we might *really* want to enforce fast (for stuff like panning or skimming?).
-- refresh methods in framebuffer implementation
@ -1064,6 +1068,8 @@ local refresh_methods = {
flashui = Screen.refreshFlashUI ,
flashpartial = Screen.refreshFlashPartial ,
full = Screen.refreshFull ,
colortext = Screen.refreshColorText ,
color = Screen.refreshColor ,
}
--[[
@ -1101,7 +1107,7 @@ Widgets call this in their `paintTo()` method in order to notify
UIManager that a certain part of the screen is to be refreshed .
@ string mode
refresh mode ( ` " full" ` , ` " flashpartial " ` , ` " flashui " ` , ` " [partial] " ` , ` " [ui] " ` , ` " partial " ` , ` " ui " ` , ` " fast " ` , ` " a2 " ` )
refresh mode ( ` " color" ` , ` " colortext " ` , ` " full" ` , ` " flashpartial " ` , ` " flashui " ` , ` " [partial] " ` , ` " [ui] " ` , ` " partial " ` , ` " ui " ` , ` " fast " ` , ` " a2 " ` )
@ param region
A rectangle @ { ui.geometry . Geom | Geom } object that specifies the region to be updated .
Optional , update will affect whole screen if not specified .