Skip to main content

partialRenderFinished

since 0.9.4

Description

AlphaTab does not render the whole music sheet into a single canvas but rather splits it down into smaller chunks. This allows faster display of results to the user and avoids issues related to browser restrictions (like maximum canvas sizes).

This event is fired whenever one chunk of the music sheet is fully rendered.

Since 1.3.0-alpha.139 the rendering of a chunk needs to be requested via the renderResult method after a chunk was advertised through the partialLayoutFinished event.

partialRenderFinishedJavaScript
PartialRenderFinished.net
## Parameters
ParametersTypeSummary
eAllalphaTab.rendering.RenderFinishedEventArgs

The object containing the information about the chunk.

eAllAlphaTab.Rendering.RenderFinishedEventArgs

The object containing the information about the chunk.

AlphaTab.Rendering.RenderFinishedEventArgs Properties

ParametersTypeSummary
idAllstring

The unique id of the chunk to request rendering through renderResult Since

1.3.0-alpha.139
xAllint

The absolute x-position of the chunk within the overall music sheet. Since

1.3.0-alpha.139
yAllint

The absolute y-position of the chunk within the overall music sheet. Since

1.3.0-alpha.139
widthAllint

The width of the current rendering result.

heightAllint

The height of the current rendering result.

totalWidthAllint

The currently known total width of the final music sheet.

totalHeightAllint

The currently known total height of the final music sheet.

firstMasterBarIndexAllint

The index of the first masterbar that was rendered in this result.

lastMasterBarIndexAllint

The last masterbar that was rendered in this result.

renderResultAllobject

The 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