This documentation is for the old version. Go to the latest Graphics Mill docs

CustomFormatReader.GetLoadingFrame Method

Returns the frame being loaded.

Namespace: Aurigma.GraphicsMill.Codecs
Assembly: Aurigma.GraphicsMill (in Aurigma.GraphicsMill.dll)

Syntax

Visual Basic
Protected Friend Function GetLoadingFrame As CustomFrame
C#
protected internal CustomFrame GetLoadingFrame()

Return Value

CustomFrame object representing the frame being loaded.

Remarks

This method should be called from the LoadFrameBitmap() or LoadFrameParameters() method if the frame object should be modified somehow, for example, if its parameters should be initialized.

Examples

C#
protected override void LoadFrameParameters()
{
    //Get the frame object (the frame currently being loaded)
    CustomFrame frame = (CustomFrame)base.GetLoadingFrame();
    
    //Initialize the frame with your settings
    //You do not have to override the InitializeCustomFrameTU method
    frame.InitializeCustomFrameTU(null, 0, 0, _width, _height,
        Aurigma.GraphicsMill.PixelFormat.Format1bppIndexed, 72.0f, 72.0f, null);
}

See Also

Reference