L4Re - L4 Runtime Environment
L4Re::Video::View Class Reference

View. More...

+ Collaboration diagram for L4Re::Video::View:

Data Structures

struct  Info
 Information structure of a view. More...
 

Public Types

enum  Flags {
  F_none = 0x00, F_set_buffer = 0x01, F_set_buffer_offset = 0x02, F_set_bytes_per_line = 0x04,
  F_set_pixel = 0x08, F_set_position = 0x10, F_dyn_allocated = 0x20, F_set_background = 0x40,
  F_set_flags = 0x80, F_fully_dynamic
}
 Flags on a view. More...
 
enum  V_flags { F_above = 0x1000, F_flags_mask = 0xff000 }
 Property flags of a view. More...
 

Public Member Functions

int info (Info *info) const throw ()
 Return the view information of the view. More...
 
int set_info (Info const &info) const throw ()
 Set the information structure for this view. More...
 
int set_viewport (int scr_x, int scr_y, int w, int h, unsigned long buf_offset) const throw ()
 Set the position of the view in the goos. More...
 
int stack (View const &pivot, bool behind=true) const throw ()
 Move this view in the view stack. More...
 
int push_top () const throw ()
 Make this view the top-most view.
 
int push_bottom () const throw ()
 Push this view the back.
 
int refresh (int x, int y, int w, int h) const throw ()
 Refresh/Redraw the view. More...
 
bool valid () const
 Return whether this view is valid.
 

Detailed Description

View.

Definition at line 34 of file goos.

Member Enumeration Documentation

◆ Flags

Flags on a view.

Enumerator
F_none 

everything for this view is static (the VESA-FB case)

F_set_buffer 

buffer object for this view can be changed

F_set_buffer_offset 

buffer offset can be set

F_set_bytes_per_line 

bytes per line can be set

F_set_pixel 

pixel type can be set

F_set_position 

position on screen can be set

F_dyn_allocated 

View is dynamically allocated.

F_set_background 

Set view as background for session.

F_set_flags 

Set view flags (.

See also
V_flags)
F_fully_dynamic 

Flags for a fully dynamic view.

Definition at line 54 of file goos.

◆ V_flags

Property flags of a view.

Such flags can be set or deleted with the F_set_flags operation using the set_info() method.

Enumerator
F_above 

Flag the view as stay on top.

F_flags_mask 

Mask containing all possible property flags.

Definition at line 77 of file goos.

Member Function Documentation

◆ info()

int L4Re::Video::View::info ( Info info) const
throw (
)
inline

Return the view information of the view.

Parameters
[out]infoInformation structure pointer.
Return values
0Success
<0Error

Definition at line 351 of file goos.

◆ refresh()

int L4Re::Video::View::refresh ( int  x,
int  y,
int  w,
int  h 
) const
throw (
)
inline

Refresh/Redraw the view.

Parameters
xX position.
yY position.
wWidth.
hHeight.
Return values
0Success
<0Error

Definition at line 363 of file goos.

◆ set_info()

int L4Re::Video::View::set_info ( Info const &  info) const
throw (
)
inline

Set the information structure for this view.

Parameters
infoInformation structure.
Return values
0Success
<0Error

The function will also set the view port according to the values given in the information structure.

Definition at line 355 of file goos.

◆ set_viewport()

int L4Re::Video::View::set_viewport ( int  scr_x,
int  scr_y,
int  w,
int  h,
unsigned long  buf_offset 
) const
throw (
)
inline

Set the position of the view in the goos.

Parameters
scr_xX position
scr_yY position
wWidth
hHeight
buf_offsetOffset in the buffer in bytes
Return values
0Success
<0Error

Definition at line 367 of file goos.

◆ stack()

int L4Re::Video::View::stack ( View const &  pivot,
bool  behind = true 
) const
throw (
)
inline

Move this view in the view stack.

Parameters
pivotView to move relative to
behindWhen true move the view behind the pivot view, if false move the view before the pivot view.
Return values
0Success
<0Error

Definition at line 359 of file goos.


The documentation for this class was generated from the following file: