Skip to main content
All docs
V25.1
  • OverlayWindowOptions.UseDirectX Property

    Gets or sets whether DirectX is used to render an Overlay Form.

    Namespace: DevExpress.XtraSplashScreen

    Assembly: DevExpress.XtraEditors.v25.1.dll

    NuGet Package: DevExpress.Win.Navigation

    Declaration

    public bool? UseDirectX { get; set; }

    Property Value

    Type Description
    Nullable<Boolean>

    true, to use DirectX; false, to use GDI+; null to use the default engine. The default engine is DirectX if the Use DirectX option is enabled in the Project settings; otherwise, the default engine is GDI+.

    Property Paths

    You can access this nested property as listed below:

    Library Object Type Path to UseDirectX
    WinForms Controls OverlayWindowOptions
    .Default .UseDirectX
    XAF: Cross-Platform .NET App UI & Web API DefaultOverlayFormOptions
    .Options .UseDirectX

    Remarks

    You can enable the Use DirectX option in the Project Settings to use DirectX Hardware Acceleration for all compatible DevExpress controls in the application.

    The UseDirectX property allows you to specify the draw engine for Overlay Forms only. This property value takes priority over the global option specified in the Project Settings. If this property is set to null, the application uses the default engine. The default engine is DirectX if the Use DirectX option is enabled in the Project settings; otherwise, the default engine is GDI+.

    using DevExpress.XtraSplashScreen;
    
    // Default setting applied to all Overlay Forms.
    DevExpress.XtraSplashScreen.OverlayWindowOptions.Default.UseDirectX = true;
    
    // Setting for an individual Overlay Form.
    IOverlaySplashScreenHandle handle = SplashScreenManager.ShowOverlayForm(
        owner: gridControl1,
        useDirectX: true
    );
    
    See Also