Skip to main content

renderFinished

since 0.9.4

Description​

This event is fired when the rendering of the whole music sheet is finished from the render engine side. There might be still tasks open for the display component to visually display the rendered components when this event is notified.

renderFinishedJavaScript
RenderFinished.net
renderFinishedAndroid

Types​

function(e)JavaScript
Action<AlphaTab.Rendering.RenderFinishedEventArgs>.net
(e : AlphaTab.Rendering.RenderFinishedEventArgs): UnitAndroid

AlphaTab.Rendering.RenderFinishedEventArgs Properties​

ParametersTypeSummary
idAllstringThe unique id of the chunk to request rendering through [`renderResult`](/docs/reference/scorerenderer/renderresult) Since 1.2.3
xAllintThe absolute x-position of the chunk within the overall music sheet. Since 1.2.3
yAllintThe absolute y-position of the chunk within the overall music sheet. Since 1.2.3
widthAllintThe width of the current rendering result.
heightAllintThe height of the current rendering result.
totalWidthAllintThe currently known total width of the final music sheet.
totalHeightAllintThe currently known total height of the final music sheet.
firstMasterBarIndexAllintThe index of the first masterbar that was rendered in this result.
lastMasterBarIndexAllintThe last masterbar that was rendered in this result.
renderResultAllobjectThe render engine specific result object which contains the rendered music sheet: - For `svg` it will contain the raw SVG string, - For `html5` it will contain a HTML5 canvas DOM element - For `skia` it will contain a `SkImage` - For `gdi` it will contain a `Bitmap`