Mir
Functions
surface.h File Reference
#include <mir_toolkit/mir_client_library.h>
#include <mir_toolkit/deprecations.h>
Include dependency graph for surface.h:

Go to the source code of this file.

Functions

int mir_debug_window_id (MirWindow *window)
 Return the ID of a window (only useful for debug output). More...
 
uint32_t mir_debug_window_current_buffer_id (MirWindow *window)
 Get the ID of the window's current buffer (only useful for debug purposes) More...
 
bool mir_debug_surface_coords_to_screen (MirSurface *surface, int x, int y, int *screen_x, int *screen_y) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_extension_window_coordinate_translation instead")
 Get the screen coordinates corresponding to a pair of surface coordinates. More...
 
int mir_debug_surface_id (MirSurface *surface) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_debug_window_id() instead")
 
uint32_t mir_debug_surface_current_buffer_id (MirSurface *surface) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_debug_window_current_buffer_id() instead")
 

Function Documentation

◆ mir_debug_surface_coords_to_screen()

bool mir_debug_surface_coords_to_screen ( MirSurface *  surface,
int  x,
int  y,
int *  screen_x,
int *  screen_y 
)

Get the screen coordinates corresponding to a pair of surface coordinates.

Precondition
The surface is valid
Parameters
[in]surfaceThe surface
[in]x,ySurface coordinates to map to screen coordinates
[out]screen_x,screen_yThe screen coordinates corresponding to x, y.
Returns
True if screen_x and screen_y contain values
Note
There are many cases where such a mapping does not exist or would be expensive to calculate. Only Mir servers started with the –debug option will ever return values for this call, and even when –debug is enabled servers are free to return nothing.

This call will only be interesting for automated testing, where both the client and shell state is known and constrained.

◆ mir_debug_surface_current_buffer_id()

uint32_t mir_debug_surface_current_buffer_id ( MirSurface *  surface)

◆ mir_debug_surface_id()

int mir_debug_surface_id ( MirSurface *  surface)

◆ mir_debug_window_current_buffer_id()

uint32_t mir_debug_window_current_buffer_id ( MirWindow window)

Get the ID of the window's current buffer (only useful for debug purposes)

Precondition
The window is valid
Parameters
[in]windowThe window
Returns
The internal buffer ID of the window's current buffer. This is the buffer that is currently being drawn to, and would be returned by mir_window_get_current_buffer.

◆ mir_debug_window_id()

int mir_debug_window_id ( MirWindow window)

Return the ID of a window (only useful for debug output).

Precondition
The window is valid
Parameters
[in]windowThe window
Returns
An internal ID that identifies the window

Copyright © 2012-2019 Canonical Ltd.
Generated on Fri Feb 1 22:50:25 UTC 2019
This documentation is licensed under the GPL version 2 or 3.