MiniGUI API Reference (MiniGUI-Processes)  v5.0.6
A mature and proven cross-platform GUI system for embedded and smart IoT devices
Data Fields
_CompositorOps Struct Reference
Functions » Global/general functions » MiniGUI-Processes specific functions » Server-only operations

#include <minigui.h>

Data Fields

CompositorCtxt *(* initialize )(const char *name)
 
void(* terminate )(CompositorCtxt *ctxt)
 
void(* refresh )(CompositorCtxt *ctxt)
 
void(* purge_ppp_data )(CompositorCtxt *ctxt, int zidx, void *data)
 
void(* purge_win_data )(CompositorCtxt *ctxt, MG_Layer *layer, int zidx, void *data)
 
void(* calc_mainwin_pos )(CompositorCtxt *ctxt, MG_Layer *layer, DWORD zt_type, int first_for_type, int cli, CALCPOSINFO *info)
 
void(* on_layer_op )(CompositorCtxt *ctxt, int layer_op, MG_Layer *layer, MG_Client *client)
 
BOOL(* reset_dirty_region )(CompositorCtxt *ctxt, MG_Layer *layer)
 
BOOL(* merge_dirty_ppp )(CompositorCtxt *ctxt, MG_Layer *layer, int zidx)
 
BOOL(* merge_dirty_win )(CompositorCtxt *ctxt, MG_Layer *layer, int zidx)
 
BOOL(* merge_dirty_wpp )(CompositorCtxt *ctxt, MG_Layer *layer)
 
BOOL(* refresh_dirty_region )(CompositorCtxt *ctxt, MG_Layer *layer)
 
void(* on_dirty_screen )(CompositorCtxt *ctxt, MG_Layer *layer, DWORD cause_type, const RECT *rc_dirty)
 
void(* on_showing_ppp )(CompositorCtxt *ctxt, int zidx)
 
void(* on_hiding_ppp )(CompositorCtxt *ctxt, int zidx)
 
void(* on_closed_menu )(CompositorCtxt *ctxt, const RECT *rc_bound)
 
void(* on_showing_win )(CompositorCtxt *ctxt, MG_Layer *layer, int zidx)
 
void(* on_hiding_win )(CompositorCtxt *ctxt, MG_Layer *layer, int zidx)
 
void(* on_raised_win )(CompositorCtxt *ctxt, MG_Layer *layer, int zidx)
 
void(* on_changed_ct )(CompositorCtxt *ctxt, MG_Layer *layer, int zidx)
 
void(* on_changed_rgn )(CompositorCtxt *ctxt, MG_Layer *layer, int zidx, const RECT *rc_org_bound)
 
void(* on_moved_win )(CompositorCtxt *ctxt, MG_Layer *layer, int zidx, const RECT *rc_org)
 
unsigned int(* composite_layers )(CompositorCtxt *ctxt, MG_Layer *layers[], int nr_layers, void *combine_param)
 
void(* transit_to_layer )(CompositorCtxt *ctxt, MG_Layer *to_layer)
 
void(* on_maximizing_win )(CompositorCtxt *ctxt, MG_Layer *layer, int zidx)
 
void(* on_minimizing_win )(CompositorCtxt *ctxt, MG_Layer *layer, int zidx)
 

Detailed Description

The struct type defines the operations for a compositor.

Definition at line 1582 of file minigui.h.

Field Documentation

◆ calc_mainwin_pos

void(* calc_mainwin_pos(CompositorCtxt *ctxt, MG_Layer *layer, DWORD zt_type, int first_for_type, int cli, CALCPOSINFO *info)

This operation calculate the default position and size for a main window with the extended style WS_EX_AUTOPOSITION.

Definition at line 1620 of file minigui.h.

◆ composite_layers

unsigned int(* composite_layers(CompositorCtxt *ctxt, MG_Layer *layers[], int nr_layers, void *combine_param)

This operation will composite multiple layers on the screen at the same time by using the combining paramemters.

Definition at line 1754 of file minigui.h.

◆ initialize

CompositorCtxt*(* initialize(const char *name)

This operation initializes the compositor and returns the compositing context.

Definition at line 1587 of file minigui.h.

◆ merge_dirty_ppp

BOOL(* merge_dirty_ppp(CompositorCtxt *ctxt, MG_Layer *layer, int zidx)

This operation will be called when there are some dirty rectangles in the specific popup menu z-node. The compositor should merge the dirty rectangles to the dirty region maintained for the current layer.

Definition at line 1644 of file minigui.h.

◆ merge_dirty_win

BOOL(* merge_dirty_win(CompositorCtxt *ctxt, MG_Layer *layer, int zidx)

This operation will be called when there are some dirty rectangles in the specific window z-node on the specific layer. The compositor should merge the dirty rectangles to the dirty region maintained for the current layer.

Definition at line 1652 of file minigui.h.

◆ merge_dirty_wpp

BOOL(* merge_dirty_wpp(CompositorCtxt *ctxt, MG_Layer *layer)

This operation will be called when there are some dirty rectangles in the wallpaper pattern. The compositor should merge the dirty rectangles of the wallpaper pattern to the dirty region maintained for the current layer.

Definition at line 1660 of file minigui.h.

◆ on_changed_ct

void(* on_changed_ct(CompositorCtxt *ctxt, MG_Layer *layer, int zidx)

This operation will be called after the system changed the compositing type of the specific window z-node. The compositor should refresh the screen to reflect the change.

Definition at line 1732 of file minigui.h.

◆ on_changed_rgn

void(* on_changed_rgn(CompositorCtxt *ctxt, MG_Layer *layer, int zidx, const RECT *rc_org_bound)

This operation will be called after the system changed the region of the specific window z-node. The compositor should update the screen to reflect the change.

Definition at line 1739 of file minigui.h.

◆ on_closed_menu

void(* on_closed_menu(CompositorCtxt *ctxt, const RECT *rc_bound)

This operation will be called when the system closed a tracking menu, The compositor can refresh the screen as there is no any popup menus. The argument rc_bound gives the bound rectangle of all visible popup menus before closing the menu.

Definition at line 1703 of file minigui.h.

◆ on_dirty_screen

void(* on_dirty_screen(CompositorCtxt *ctxt, MG_Layer *layer, DWORD cause_type, const RECT *rc_dirty)

This operation will be called when a z-node was out of action, e.g., the z-node was hidden or released. The argument layer gives the layer which has the dirty rectangle; NULL for the topmost layer. The argument cause_type gives the type of the z-node which caused the action. For the available z-node types, please refer to ZNODEINFO. The argument rc_dirty contains the rectangle of the z-node in screen coordinates. The compositor should refresh the screen for the dirty rectangle.

Definition at line 1679 of file minigui.h.

◆ on_hiding_ppp

void(* on_hiding_ppp(CompositorCtxt *ctxt, int zidx)

This operation will be called when the system is hiding a popup menu. The compositor may purge the private data in this operation. The compositor can play an animation in this operation.

Definition at line 1695 of file minigui.h.

◆ on_hiding_win

void(* on_hiding_win(CompositorCtxt *ctxt, MG_Layer *layer, int zidx)

This operation will be called when the system is hidding a window. The compositor may purge the private data in this operation. The compositor can play an animation in this operation.

Definition at line 1718 of file minigui.h.

◆ on_layer_op

void(* on_layer_op(CompositorCtxt *ctxt, int layer_op, MG_Layer *layer, MG_Client *client)

This operation will be called when there was a layer operation. For more information, please refer to OnChangeLayer.

Definition at line 1627 of file minigui.h.

◆ on_maximizing_win

void(* on_maximizing_win(CompositorCtxt *ctxt, MG_Layer *layer, int zidx)

This operation will be called when the system is maximizing a window. The compositor can play an animation in this operation.

Definition at line 1768 of file minigui.h.

◆ on_minimizing_win

void(* on_minimizing_win(CompositorCtxt *ctxt, MG_Layer *layer, int zidx)

This operation will be called when the system is manimizing a window. The compositor can play an animation in this operation.

Definition at line 1774 of file minigui.h.

◆ on_moved_win

void(* on_moved_win(CompositorCtxt *ctxt, MG_Layer *layer, int zidx, const RECT *rc_org)

This operation will be called after the system moved a window. The compositor should update the screen to reflect the change. The argument rc_org gives the original rectangle of the window.

Definition at line 1747 of file minigui.h.

◆ on_raised_win

void(* on_raised_win(CompositorCtxt *ctxt, MG_Layer *layer, int zidx)

This operation will be called after the system raised the window z-node to top. The compositor should refresh the screen to reflect the change.

Definition at line 1725 of file minigui.h.

◆ on_showing_ppp

void(* on_showing_ppp(CompositorCtxt *ctxt, int zidx)

This operation will be called when the system is showing a new popup menu. Note that the compositor can not assume that there are contents in the surface of the popup menu; but it can update some internal data in this operation.

Definition at line 1688 of file minigui.h.

◆ on_showing_win

void(* on_showing_win(CompositorCtxt *ctxt, MG_Layer *layer, int zidx)

This operation will be called when the system is showing a window. Note that the compositor can not assume that there are contents in the surface of the window, but it can update some internal data in this operation.

Definition at line 1711 of file minigui.h.

◆ purge_ppp_data

void(* purge_ppp_data(CompositorCtxt *ctxt, int zidx, void *data)

This operation purges the private data of a popup menu z-node. It will be called before terminating the compositor for any popup menu z-node which has a non-NULL private data.

Definition at line 1606 of file minigui.h.

◆ purge_win_data

void(* purge_win_data(CompositorCtxt *ctxt, MG_Layer *layer, int zidx, void *data)

This operation purges the private data of a window z-node. It will be called before terminating the compositor for any window z-node which has a non-NULL private data.

Definition at line 1613 of file minigui.h.

◆ refresh

void(* refresh(CompositorCtxt *ctxt)

This operation refreshes the whole screen due to the change of the compositor or the topmost layer.

Definition at line 1599 of file minigui.h.

◆ refresh_dirty_region

BOOL(* refresh_dirty_region(CompositorCtxt *ctxt, MG_Layer *layer)

This operation will be called to composite the dirty region for the particular layer.

Definition at line 1666 of file minigui.h.

◆ reset_dirty_region

BOOL(* reset_dirty_region(CompositorCtxt *ctxt, MG_Layer *layer)

This operation will be called when the server intends to composite the whole screen for the particular layer. The compositor can reset the dirty region for the layer. If it returns FALSE, the compositor will not handle the layer.

Definition at line 1636 of file minigui.h.

◆ terminate

void(* terminate(CompositorCtxt *ctxt)

This operation destroies the compositing context and terminates the compositor.

Definition at line 1593 of file minigui.h.

◆ transit_to_layer

void(* transit_to_layer(CompositorCtxt *ctxt, MG_Layer *to_layer)

This operation will be called when transiting to a new topmost layer. The compositor can play an animation to transit from the current topmost layer to the new topmost layer.

Definition at line 1762 of file minigui.h.

The documentation for this struct was generated from the following file:
Generated by   doxygen 1.8.17