GTLCore Library

Namespaces
namespace	GTLCore::ErrorMessages
Modules
	GTLCore AST Library
	GTLCore Metadata Library
	GTLCore TimeMachine Library
Classes
class	GTLCore::AbstractImage
class	GTLCore::Array
class	GTLCore::Buffer
class	GTLCore::BufferImage
class	GTLCore::ChannelsFlags
class	GTLCore::CompilationMessage
class	GTLCore::CompilationMessages
class	GTLCore::CompilerBase
class	GTLCore::ConvertCenter
class	GTLCore::ConvertExpressionFactory
class	GTLCore::Debug
class	GTLCore::Function
struct	GTLCore::Function::Private
class	GTLCore::FunctionCaller
class	GTLCore::Image
class	GTLCore::LexerBase
class	LLVMBackend::CodeGenerator
class	LLVMBackend::ExpressionResult
class	LLVMBackend::GenerationContext
class	LLVMBackend::Visitor
	This is an interface that defines functions use to access the member of a variable. More...
struct	GTLCore::Details::ForeachInfoBase
struct	GTLCore::Details::ForeachInfo< T >
class	GTLCore::MemoryManager
class	GTLCore::ModuleData
class	GTLCore::Parameter
class	GTLCore::ParserBase
class	GTLCore::PixelDescription
class	GTLCore::PrimitiveTypeTrait< _TYPE_ >
class	GTLCore::PrimitiveTypeTrait< int >
class	GTLCore::PrimitiveTypeTrait< unsigned int >
class	GTLCore::PrimitiveTypeTrait< bool >
class	GTLCore::PrimitiveTypeTrait< float >
class	GTLCore::ValueToArray
class	GTLCore::ValueToArrayImpl< _TYPE_ >
class	GTLCore::ArrayToValue
class	GTLCore::ArrayToValueImpl< _TYPE_ >
class	GTLCore::ProgressReport
class	GTLCore::Region< _T_ >
class	GTLCore::RegionI
class	GTLCore::RegionF
class	GTLCore::ScopedName
class	GTLCore::String
struct	GTLCore::Token
class	GTLCore::Transform
struct	GTLCore::Type
class	GTLCore::Type::AribtraryTypeFactory
struct	GTLCore::TypesManager
class	GTLCore::Value
class	GTLCore::VariableNG
class	GTLCore::VariablesManager
class	GTLCore::VirtualMachine
struct	ArrayWrap
Defines
#define	STATIC_INITIALISATION(_name_)
#define	STATIC_DELETER(_name_)
#define	STATIC_POINTER(_type_, _name_)
#define	foreach(var, cont)
Functions
GTLCORE_EXPORT float	half2float (GTLCore::half v)
GTLCORE_EXPORT GTLCore::half	float2half (float f)
template<class _Type_>
void	GTLCore::deleteAll (_Type_ &list)
template<class _Type_>
void	GTLCore::deleteAllSecondMember (_Type_ &map)
template<class _T_>
ArrayWrap *	gtlAllocateArray (int _size)
void	gtlFreeArray (ArrayWrap *aw)
template<typename _T_>
void	gtlFreeAllArray (ArrayWrap *aw)

---

Detailed Description

Version:

0.9.15

Author:

Cyrille Berger

This library contains the core functionnalities used by the compilers, and some convenient classes.

---

Define Documentation

#define foreach	(	var,
		cont		)

Value:

for( const GTLCore::Details::ForeachInfoBase&  contInfo = GTLCore::Details::CreateForeachInfo( cont ); \
       not GTLCore::Details::getForeachInfo( &contInfo, true ? 0 : GTLCore::Details::getForeachType(cont) )->finished(); \
       GTLCore::Details::getForeachInfo( &contInfo, true ? 0 : GTLCore::Details::getForeachType(cont) )->next() ) \
    for( var = *GTLCore::Details::getForeachInfo( &contInfo, true ? 0 : GTLCore::Details::getForeachType(cont) )->it; \
         GTLCore::Details::getForeachInfo( &contInfo, true ? 0 : GTLCore::Details::getForeachType(cont) )->count < 1; \
         ++GTLCore::Details::getForeachInfo( &contInfo, true ? 0 : GTLCore::Details::getForeachType(cont) )->count )

For internal use only.

Macro to easilly iterate over elements of a countainer.

 std::vector\<Object\> objects;
 foreach(const Object& object, objects)
 {
   ...
 }

#define STATIC_DELETER

(

_name_

)

Value:

class _name_##Deleter { \
    public: \
      _name_##Deleter() {} \
      ~_name_##Deleter(); \
  }; \
  _name_##Deleter instance##_name_ ; \
  _name_##Deleter::~_name_##Deleter()

For internal use only.

Allows to execute code at library deletion.

 class CoolObject {};
 static std::vector\<CoolObject*\> staticCoolInstances;
 STATIC_DELETER( CoolObjects )
 {
  for(int i =0; i \< staticCoolInstances.size(); ++i)
    delete staticCoolInstances[i];
 }

This will create a CoolObjectsDeleter that you can use to declare a friend class.

#define STATIC_INITIALISATION

(

_name_

)

Value:

class _name_##Factory { \
    public: \
      _name_##Factory(); \
  }; \
  _name_##Factory instance##_name_ ; \
  _name_##Factory::_name_##Factory()

For internal use only.

Allows to execute code at library initialisation.

 class CoolObject {};
 static std::vector\<CoolObject*\> staticCoolInstances;
 STATIC_INITIALISATION( CoolObjects )
 {
  for(int i =0; i < 10; ++i)
    staticCoolInstances.push_back( new CoolObject() );
 }

This will create a CoolObjectsFactory that you can use to declare a friend class.

#define STATIC_POINTER	(	_type_,
		_name_		)

Value:

namespace { \
    class StaticPointer##_type_ { \
        _type_* t; \
        StaticPointer##_type_(const StaticPointer##_type_& ); \
        StaticPointer##_type_& operator=(const StaticPointer##_type_& ); \
      public: \
        StaticPointer##_type_() : t(0) {} \
        ~StaticPointer##_type_() { delete t; t = 0; } \
        inline operator _type_*() { return t; } \
        inline _type_* operator->() { return t; } \
        StaticPointer##_type_& operator=(_type_* _t) { t = _t; return *this; } \
    }; \
    StaticPointer##_type_ _name_; \
  }

For internal use only.

Used for static pointer that are deleted at exit time.

---

Function Documentation

template<class _Type_>

void GTLCore::deleteAll

(

_Type_ &

list

)

[inline]

For internal use only.

Delete all pointers of a list or a vector.

template<class _Type_>

void GTLCore::deleteAllSecondMember

(

_Type_ &

map

)

[inline]

For internal use only.

Delete all second members of a map

GTLCORE_EXPORT GTLCore::half float2half

(

float

f

)

For internal use only.

This function convert from float to half. It's private to OpenGTL, if you want to use half channels in your application, you are invited to use IlmBase (http://www.openexr.com/).

template<class _T_>

ArrayWrap* gtlAllocateArray

(

int

_size

)

[inline]

For internal use only.

This template function allow to create an array of elements _T_ this function will call the GTLCore::MemoryManager function as needed.

Parameters:

_size

is the number of elements in the array

References ArrayWrap::data, and ArrayWrap::size.

template<typename _T_>

void gtlFreeAllArray

(

ArrayWrap *

aw

)

[inline]

For internal use only.

Free the memory used by an array of pointers, and by its members.

References ArrayWrap::data, and ArrayWrap::size.

void gtlFreeArray

(

ArrayWrap *

aw

)

[inline]

For internal use only.

Free the memory used by an array.

References ArrayWrap::data.

GTLCORE_EXPORT float half2float

(

GTLCore::half

v

)

For internal use only.

This function convert from half to float. It's private to OpenGTL, if you want to use half channels in your application, you are invited to use IlmBase (http://www.openexr.com/).