sungmg/mutter-performance-source
1
0
Fork 0
Code Activity
mutter-performance-source/cogl/cogl-output.h
Lionel Landwerlin 1b2dd815b4 Registers gtypes for all public objects and structs 
This adds much more comprehensive support for gobject-introspection
based bindings by registering all objects as fundamental types that
inherit from CoglObject, and all structs as boxed types.

Co-Author: Robert Bragg <robert@linux.intel.com>

Reviewed-by: Neil Roberts <neil@linux.intel.com>
2014-03-20 18:27:12 +00:00

261 lines
7.3 KiB
C
Raw Blame History

/*
* Cogl
*
* A Low Level GPU Graphics and Utilities API
*
* Copyright (C) 2012 Red Hat, Inc.
*
* 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.
*
*
*
* Authors:
* Owen Taylor <otaylor@redhat.com>
*/
#if !defined(__COGL_H_INSIDE__) && !defined(COGL_COMPILATION)
#error "Only <cogl/cogl.h> can be included directly."
#endif
#ifndef __COGL_OUTPUT_H
#define __COGL_OUTPUT_H
#include <cogl/cogl-types.h>
#ifdef COGL_HAS_GTYPE_SUPPORT
#include <glib-object.h>
#endif
COGL_BEGIN_DECLS
/**
* SECTION:cogl-output
* @short_description: information about an output device
*
* The #CoglOutput object holds information about an output device
* such as a monitor or laptop display. It can be queried to find
* out the position of the output with respect to the screen
* coordinate system and other information such as the resolution
* and refresh rate of the device.
*
* There can be any number of outputs which may overlap: the
* same area of the screen may be displayed by multiple output
* devices.
*
* XXX: though it's possible to query the position of the output
* with respect to screen coordinates, there is currently no way
* of finding out the position of a #CoglOnscreen in screen
* coordinates, at least without using windowing-system specific
* API's, so it's not easy to get the output positions relative
* to the #CoglOnscreen.
*/
typedef struct _CoglOutput CoglOutput;
#define COGL_OUTPUT(X) ((CoglOutput *)(X))
#ifdef COGL_HAS_GTYPE_SUPPORT
/**
* cogl_output_get_gtype:
*
* Returns: a #GType that can be used with the GLib type system.
*/
GType cogl_output_get_gtype (void);
#endif
/**
* CoglSubpixelOrder:
* @COGL_SUBPIXEL_ORDER_UNKNOWN: the layout of subpixel
* components for the device is unknown.
* @COGL_SUBPIXEL_ORDER_NONE: the device displays colors
* without geometrically-separated subpixel components,
* or the positioning or colors of the components do not
* match any of the values in the enumeration.
* @COGL_SUBPIXEL_ORDER_HORIZONTAL_RGB: the device has
* horizontally arranged components in the order
* red-green-blue from left to right.
* @COGL_SUBPIXEL_ORDER_HORIZONTAL_BGR: the device has
* horizontally arranged components in the order
* blue-green-red from left to right.
* @COGL_SUBPIXEL_ORDER_VERTICAL_RGB: the device has
* vertically arranged components in the order
* red-green-blue from top to bottom.
* @COGL_SUBPIXEL_ORDER_VERTICAL_BGR: the device has
* vertically arranged components in the order
* blue-green-red from top to bottom.
*
* Some output devices (such as LCD panels) display colors
* by making each pixel consist of smaller "subpixels"
* that each have a particular color. By using knowledge
* of the layout of this subpixel components, it is possible
* to create image content with higher resolution than the
* pixel grid.
*
* Since: 1.14
* Stability: unstable
*/
typedef enum {
COGL_SUBPIXEL_ORDER_UNKNOWN,
COGL_SUBPIXEL_ORDER_NONE,
COGL_SUBPIXEL_ORDER_HORIZONTAL_RGB,
COGL_SUBPIXEL_ORDER_HORIZONTAL_BGR,
COGL_SUBPIXEL_ORDER_VERTICAL_RGB,
COGL_SUBPIXEL_ORDER_VERTICAL_BGR
} CoglSubpixelOrder;
/**
* cogl_is_output:
* @object: A #CoglObject pointer
*
* Gets whether the given object references a #CoglOutput.
*
* Return value: %TRUE if the object references a #CoglOutput
* and %FALSE otherwise.
* Since: 1.14
* Stability: unstable
*/
CoglBool
cogl_is_output (void *object);
/**
* cogl_output_get_x:
* @output: a #CoglOutput
*
* Gets the X position of the output with respect to the coordinate
* system of the screen.
*
* Return value: the X position of the output as a pixel offset
* from the left side of the screen coordinate space
* Since: 1.14
* Stability: unstable
*/
int
cogl_output_get_x (CoglOutput *output);
/**
* cogl_output_get_y:
* @output: a #CoglOutput
*
* Gets the Y position of the output with respect to the coordinate
* system of the screen.
*
* Return value: the Y position of the output as a pixel offset
* from the top side of the screen coordinate space
* Since: 1.14
* Stability: unstable
*/
int
cogl_output_get_y (CoglOutput *output);
/**
* cogl_output_get_width:
* @output: a #CoglOutput
*
* Gets the width of the output in pixels.
*
* Return value: the width of the output in pixels
* Since: 1.14
* Stability: unstable
*/
int
cogl_output_get_width (CoglOutput *output);
/**
* cogl_output_get_height:
* @output: a #CoglOutput
*
* Gets the height of the output in pixels.
*
* Return value: the height of the output in pixels
* Since: 1.14
* Stability: unstable
*/
int
cogl_output_get_height (CoglOutput *output);
/**
* cogl_output_get_mm_width:
* @output: a #CoglOutput
*
* Gets the physical width of the output. In some cases (such as
* as a projector), the value returned here might correspond to
* nominal resolution rather than the actual physical size of the
* output device.
*
* Return value: the height of the output in millimeters. A value
* of 0 indicates the width is unknown
* Since: 1.14
* Stability: unstable
*/
int
cogl_output_get_mm_width (CoglOutput *output);
/**
* cogl_output_get_mm_height:
* @output: a #CoglOutput
*
* Gets the physical height of the output. In some cases (such as
* as a projector), the value returned here might correspond to
* nominal resolution rather than the actual physical size of the
* output device.
*
* Return value: the height of the output in millimeters. A value
* of 0 indicates that the height is unknown
* Since: 1.14
* Stability: unstable
*/
int
cogl_output_get_mm_height (CoglOutput *output);
/**
* cogl_output_get_subpixel_order:
* @output: a #CoglOutput
*
* For an output device where each pixel is made up of smaller components
* with different colors, returns the layout of the subpixel
* components.
*
* Return value: the order of subpixel components for the output device
* Since: 1.14
* Stability: unstable
*/
CoglSubpixelOrder
cogl_output_get_subpixel_order (CoglOutput *output);
/**
* cogl_output_get_refresh_rate:
* @output: a #CoglOutput
*
* Gets the number of times per second that the output device refreshes
* the display contents.
*
* Return value: the refresh rate of the output device. A value of zero
* indicates that the refresh rate is unknown.
* Since: 1.14
* Stability: unstable
*/
float
cogl_output_get_refresh_rate (CoglOutput *output);
COGL_END_DECLS
#endif /* __COGL_OUTPUT_H */
View git blame Copy permalink