mutter/cogl/cogl-mir-renderer.h
2014-11-20 07:17:19 +01:00

86 lines
2.9 KiB
C

/*
* Cogl
*
* A Low Level GPU Graphics and Utilities API
*
* Copyright (C) 2014 Canonical Ltd.
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use, copy,
* modify, merge, publish, distribute, sublicense, and/or sell copies
* of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#if !defined(__COGL_H_INSIDE__) && !defined(COGL_COMPILATION)
#error "Only <cogl/cogl.h> can be included directly."
#endif
#ifndef __COGL_MIR_RENDERER_H__
#define __COGL_MIR_RENDERER_H__
#include <cogl/cogl-types.h>
#include <cogl/cogl-renderer.h>
#include <mir_toolkit/mir_client_library.h>
COGL_BEGIN_DECLS
/**
* cogl_mir_renderer_set_foreign_connection:
* @renderer: A #CoglRenderer
* @connection: A Mir connection
*
* Allows you to explicitly control what Mir connection you want Cogl
* to work with instead of leaving Cogl to automatically connect to a
* mir server.
*
* Returns: whether @connection has been marked as been set as connection or not.
*
* Since: 1.8
* Stability: unstable
*/
CoglBool
cogl_mir_renderer_set_foreign_connection (CoglRenderer *renderer,
MirConnection *connection);
/**
* cogl_mir_renderer_get_connection:
* @renderer: A #CoglRenderer
*
* Retrieves the Mir Connection that Cogl is using. If a foreign
* connection has been specified using
* cogl_mir_renderer_set_foreign_connection() then that connection will
* be returned. If no foreign connection has been specified then the
* display that Cogl creates internally will be returned unless the
* renderer has not yet been connected (either implicitly or explicitly by
* calling cogl_renderer_connect()) in which case %NULL is returned.
*
* Returns: The mir connection currently associated with @renderer,
* or %NULL if the renderer hasn't yet been connected and no
* foreign connection has been specified.
*
* Since: 1.8
* Stability: unstable
*/
MirConnection *
cogl_mir_renderer_get_connection (CoglRenderer *renderer);
COGL_END_DECLS
#endif /* __COGL_MIR_RENDERER_H__ */