gsplash
Loading...
Searching...
No Matches
Data Structures | Functions
Core API
GSplash module

Public classes and functions for the GSplash module. More...

Collaboration diagram for Core API:

Data Structures

class  GSplash
 Splash screen utility for GUI runs. More...

Functions

GOptions gsplash::defineOptions ()
 Namespace utilities for the GSplash module.

Detailed Description

Function Documentation

◆ defineOptions()

GOptions gsplash::defineOptions ( )
inline

Defines the module options for GSplash.

This helper returns a GOptions instance configured for the GSplash module namespace. Applications typically merge/collect options from multiple modules and construct a shared GOptions instance from argc/argv and module definitions.

Expected options consumed by GSplash at runtime include:

  • --gui : when enabled, GSplash will create and show a splash screen; otherwise GSplash::create returns nullptr.
  • -splash_time : minimum time in seconds to keep the splash visible before closing it.
  • -splash_scale : scale factor applied to the loaded splash image.
Returns
A GOptions definition for the GSplash module.

Definition at line 46 of file gsplash.h.