← Back to branch summary

~mir-team/mir/trunk

« back to all changes in this revision

Viewing changes to include/client/mir_toolkit/mir_client_library.h

  • Committer: Tarmac
  • Author(s): Daniel van Vugt
  • Date: 2013-03-22 03:33:00 UTC
  • mfrom: (440.1.138 surface-types)
  • Revision ID: tarmac-20130322033300-qj6cjcvsqhl4mpaw
Add support for surface types (client API, protocol and server).

This work will also form the foundation of supporting surface states.

Approved by PS Jenkins bot, Alan Griffiths, Robert Ancell.

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/client/mir_toolkit/mir_client_library.h
18
18
#ifndef MIR_CLIENT_LIBRARY_H
19
19
#define MIR_CLIENT_LIBRARY_H
20
20
 
 
21
#include <mir_toolkit/common.h>
 
22
 
21
23
#ifdef __cplusplus
22
24
/** The C client API
23
25
 */
358
360
 */
359
361
int mir_debug_surface_id(MirSurface *surface);
360
362
 
 
363
/**
 
364
 * Set the type (purpose) of a surface. This is not guaranteed to always work
 
365
 * with some shell types (e.g. phone/tablet UIs). As such, you may have to
 
366
 * wait on the function and check the result using mir_surface_get_type.
 
367
 *   \param [in] surface  The surface to operate on
 
368
 *   \param [in] type     The new type of the surface
 
369
 *   \return              A wait handle that can be passed to mir_wait_for
 
370
 */
 
371
MirWaitHandle* mir_surface_set_type(MirSurface *surface, MirSurfaceType type);
 
372
 
 
373
/**
 
374
 * Get the type (purpose) of a surface.
 
375
 *   \param [in] surface  The surface to query
 
376
 *   \return              The type of the surface
 
377
 */
 
378
MirSurfaceType mir_surface_get_type(MirSurface *surface);
 
379
 
361
380
#ifdef __cplusplus
362
381
}
363
382
}