mutter/cogl/cogl-kms-display.h

/*
 * Cogl
 *
 * A Low Level GPU Graphics and Utilities API
 *
 * Copyright (C) 2012 Intel Corporation.
 *
 * 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_KMS_DISPLAY_H__
#define __COGL_KMS_DISPLAY_H__

#include <cogl/cogl-types.h>
#include <cogl/cogl-display.h>

#include <xf86drmMode.h>

COGL_BEGIN_DECLS

/**
 * cogl_kms_display_queue_modes_reset:
 * @display: A #CoglDisplay
 *
 * Asks Cogl to explicitly reset the crtc output modes at the next
 * #CoglOnscreen swap_buffers request. For applications that support
 * VT switching they may want to re-assert the output modes when
 * switching back to the applications VT since the modes are often not
 * correctly restored automatically.
 *
 * <note>The @display must have been either explicitly setup via
 * cogl_display_setup() or implicitily setup by having created a
 * context using the @display</note>
 *
 * Since: 2.0
 * Stability: unstable
 */
void
cogl_kms_display_queue_modes_reset (CoglDisplay *display);

typedef struct {
  uint32_t id;
  uint32_t x, y;
  drmModeModeInfo mode;

  uint32_t *connectors;
  uint32_t  count;
 
  CoglBool  ignore;
} CoglKmsCrtc;

/**
 * cogl_kms_display_set_layout:
 * @onscreen: a #CoglDisplay
 * @width: the framebuffer width
 * @height: the framebuffer height
 * @crtcs: the array of #CoglKmsCrtc structure with the desired CRTC layout
 *
 * Configures @display to use a framebuffer sized @width x @height, covering
 * the CRTCS in @crtcs.
 * @width and @height must be within the driver framebuffer limits, and @crtcs
 * must be valid KMS API IDs.
 *
 * Calling this function overrides the automatic mode setting done by Cogl,
 * and for this reason must be called before the first call to cogl_onscreen_swap_buffers().
 *
 * If you want to restore the default behaviour, you can call this function
 * with @width and @height set to -1.
 *
 * Stability: unstable
 */
CoglBool
cogl_kms_display_set_layout (CoglDisplay *display,
                             int width,
                             int height,
                             CoglKmsCrtc **crtcs,
                             int n_crtcs,
                             CoglError **error);


/**
 * cogl_kms_display_set_ignore_crtc:
 * @onscreen: a #CoglDisplay
 * @id: KMS output id
 * @ignore: Ignore ouput or not
 *
 * Tells cogl to ignore (or stop ignoring) a ctrc which means
 * it never flips buffers at this crtc.
 *
 * Stability: unstable
 */
void
cogl_kms_display_set_ignore_crtc (CoglDisplay *display,
                                  uint32_t id,
                                  CoglBool ignore);
COGL_END_DECLS
#endif /* __COGL_KMS_DISPLAY_H__ */