Oyranos Colour Management System API

Oyranos Documentation

0.1.10

Descriptive Contents

Introduction | Installation | References
User Tools Documentation | Environment Variables | User API Documentation | Programming Tutorial

Author:
Kai-Uwe Behrmann and others
Since:
March 2004
Internet:
http://www.oyranos.org



Introduction

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.

User Tools Documentation

User API Documentation

The basic Oyranos API gets included with oyranos.h. An application, which wants to use these functions, needs to link against Oyranos and Elektra.

The monitor related API is contained in oyranos_monitor.h. Linking against the X11 libraries on Linux is done on runtime.

The key names, which Oyranos uses to store its configuration in an Elektra file tree, are defined in oyranos_definitions.h.

More in depth topics about programming with Oyranos can be found on the coding page.

Programming Tutorial

Frist you have to put a

    #include <oyranos.h> 

in your source text, in order to use Oyranos.

    int oyranos_version = oyVersion(); 

oyranos-config --cflags delivers the compiler flags and oyranos-config --ldflags the linker flags.

Then you can put Oyranos functions in your code and compile with:

    cc `oyranos-config --cflags` `oyranos-config --ldflags` mycode.c -o myApp 

to link Oyranos into your application.

The namespace in C++ is oyranos:: , e.g. oyranos::oyVersion().

Writing of filters and modules for Oyranos is covered in the extending_oyranos page.