Oyranos Color Management System API
Public Member Functions | Data Fields
oyStruct_s Struct Reference

Oyranos base structure. More...

#include <oyStruct_s.h>

Inheritance diagram for oyStruct_s:
Inheritance graph
Collaboration diagram for oyStruct_s:
Collaboration graph

Public Member Functions

const char * oyStruct_GetTextFromModule (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
 get object infos from a module More...
 
const char * oyStruct_GetText (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
 get a text dump More...
 

Data Fields

const oyOBJECT_e type_
 Type of object. More...
 
oyStruct_Copy_f copy
 Copy function. More...
 
oyStruct_Release_f release
 Release function. More...
 
oyObject_s oy_
 Oyranos internal object. More...
 

Detailed Description

Oyranos base structure.

All inherited Oyranos structures should be castable to this basic one.

Note
New templates will not be created automaticly [notemplates]
Version
Oyranos: x.x.x
Since
Oyranos: version 0.1.8
Date
1 january 2008 (API 0.1.8)

Member Function Documentation

◆ oyStruct_GetText()

const char * oyStruct_GetText ( oyStruct_s obj,
oyNAME_e  name_type,
uint32_t  flags 
)

get a text dump

Function oyStruct_GetText

Ask the object type module for text informations.

Parameters
objthe object
name_typethe text type
flags
  • 0: get object infos
  • 1: get object type infos
Returns
the text
Version
Oyranos: 0.1.10
Since
2009/09/14 (Oyranos: 0.1.10)
Date
2009/09/15

◆ oyStruct_GetTextFromModule()

const char * oyStruct_GetTextFromModule ( oyStruct_s obj,
oyNAME_e  name_type,
uint32_t  flags 
)

get object infos from a module

Parameters
[in,out]objthe objects structure
[in]name_typethe type
[in]flags
See also
oyStruct_GetText
Returns
the text
Version
Oyranos: 0.3.3
Since
2009/09/15 (Oyranos: 0.3.3)
Date
2011/10/31

Field Documentation

◆ copy

oyStruct_Copy_f oyStruct_s::copy

◆ oy_

oyObject_s oyStruct_s::oy_

◆ release

oyStruct_Release_f oyStruct_s::release

◆ type_

const oyOBJECT_e oyStruct_s::type_

Type of object.

The struct type tells Oyranos how to interprete hidden fields.

Referenced by oyStruct_CheckType(), oyStruct_GetAllocator(), oyStruct_GetDeAllocator(), oyStructList_s::oyStructList_GetRefType(), and oyStructList_s::oyStructList_GetType().