<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"/>
<meta name="keywords" content="Oyranos,Colour Management,Color Management,ICC,CMS,C,doxygen,API,documentation"/>
<meta name="description" content="C source code API documentation for the Oyranos project."/>
<title>Oyranos: Main Page</title>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<table class="title">
<tr>
<td class='logo' rowspan="2"><a href='http://www.oyranos.org'><img src='oyranos_logo.png' alt="Oyranos Icon linux/BSD/Unix/osX" border="0"/></a></td>
<td>Oyranos Colour Management System API</td>
</tr>
</table>
<!-- Generated by Doxygen 1.7.3 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li class="current"><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="headertitle">
<h1>Oyranos Documentation</h1> </div>
</div>
<div class="contents">
<div class="textblock"><h2><a class="anchor" id="text_contents"></a>
Descriptive Contents</h2>
<p><a class="el" href="index.html#intro">Introduction</a> | <a class="el" href="install_current.html#install">Installation</a> | <a class="el" href="links.html">References</a><br/>
<a class="el" href="index.html#tools">User Tools Documentation</a> | <a class="el" href="environment.html">Environment Variables</a> | <a class="el" href="index.html#user">User API Documentation</a> | <a class="el" href="index.html#api_tutorial">Programming Tutorial</a></p>
<dl class="author"><dt><b>Author:</b></dt><dd>Kai-Uwe Behrmann and others </dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>March 2004</dd></dl>
<dl class="user"><dt><b>Internet:</b></dt><dd><a href="http://www.oyranos.org">http://www.oyranos.org</a></dd></dl>
<p><br/>
<br/>
</p>
<h2><a class="anchor" id="intro"></a>
Introduction</h2>
<p>Oyranos is intended as a entry point for colour savy applications. In its current stage it configures profile paths, sets default profiles, maps devices to profiles, sets a monitor profile in X and uploads a vcgt tag. This means for instance all applications using Oyranos will use for a incoming digital camera picture the same profile and watch it through the same monitor profile with the same options for rendering intent, simulation and so on.</p>
<h2><a class="anchor" id="tools"></a>
User Tools Documentation</h2>
<ul>
<li>oyranos-monitor - a commandline tool for calling from a setup script like .xinitrc. It selects a profile for the current monitor and sets up the X server at startup time. Usage: <div class="fragment"><pre class="fragment">
# select a monitor profile, load the binary blob into X and fill the
# VideoCardGammaTable, if appropriate
oyranos-monitor
</pre></div></li>
<li>oyranos-policy - a tool to set a policy from a xml file. Use it like: <div class="fragment"><pre class="fragment">
oyranos-policy `oyranos-config --syscolordir`/`oyranos-config --settingsdirname`/office.policy.xml
</pre></div> Affected are default profiles and some behaviour settings.</li>
<li><a href="http://www.oyranos.org/wiki/index.php?title=Oyranos_Configuration_Dialog">oyranos-config-fltk</a> - a configuration UI application, using some functions of the Oyranos APIs. If you have <a href="http://www.oyranos.org/wiki/index.php?title=ICC_Examin">ICC Examin</a> installed it can be called to show details of profiles.</li>
<li>oyranos-config - a command line tool to get compiler flags to using Oyranos in your own project. Try <em>oyranos-config</em> <em>--help</em> to see the appropriate options.</li>
</ul>
<h2><a class="anchor" id="user"></a>
User API Documentation</h2>
<p>The basic Oyranos API gets included with <a class="el" href="oyranos_8h.html" title="The API header for general users to include in your application.">oyranos.h</a>. An application, which wants to use these functions, needs to link against Oyranos and Elektra.</p>
<ul>
<li><a class="el" href="group__policy.html">Policy API</a> - load / save of user policies</li>
<li><a class="el" href="group__options.html">Options API</a> - layout and describe options to the user; part of user policies</li>
<li><a class="el" href="group__behaviour.html">Behaviour API</a> - get and set common behaviour; part of user policies</li>
<li><a class="el" href="group__default__profiles.html">Default Profiles API</a> - get and set commonly used profiles; part of user policies</li>
<li><a class="el" href="group__profile__lists.html">Profile Lists API</a> - provides the search path content as profile lists for your GUI</li>
<li><a class="el" href="group__profile__handling.html">Profile Handling API</a> - file I/O and more</li>
</ul>
<p>The monitor related API is contained in alpha/oyranos_alpha.h. Loading of the according module for the X11 libraries on Linux is done on runtime.</p>
<p>The key names, which Oyranos uses to store its configuration in an Elektra file tree, are defined in oyranos_definitions.h. <br/>
</p>
<p>More in depth topics about programming with Oyranos can be found on the coding page.</p>
<h3><a class="anchor" id="api_tutorial"></a>
Programming Tutorial</h3>
<p>Frist you have to put a </p>
<div class="fragment"><pre class="fragment">
#include <oyranos.h> </pre></div><p> in your source text, in order to use Oyranos. </p>
<div class="fragment"><pre class="fragment">
int oyranos_version = oyVersion(); </pre></div><p> <b>oyranos-config</b> <b>--cflags</b> delivers the compiler flags and <b>oyranos-config</b> <b>--ldflags</b> the linker flags.</p>
<p>Then you can put Oyranos functions in your code and compile with: </p>
<div class="fragment"><pre class="fragment">
cc `oyranos-config --cflags` `oyranos-config --ldflags` mycode.c -o myApp </pre></div><p> to link Oyranos into your application.</p>
<p>The namespace in C++ is oyranos:: , e.g. oyranos::oyVersion().</p>
<p>Writing of filters and modules for Oyranos is covered in the extending_oyranos page. </p>
</div></div>
<hr>
<p class="footer">
Generated on Wed Feb 9 2011 05:26:21 for <a href="http://www.oyranos.org">Oyranos</a> by
<a href="http://www.doxygen.org"><img src="doxygen.png" alt="Doxygen"
align="middle" border="0"/>1.7.3</a><br/>
Copyright © 2004-2009 Kai-Uwe Behrmann and others.
All Rights Reserved.</p>
<hr>
<!--#include virtual="/attrib.incl" -->
</body>
</html>
