GUIDOLib  1.6.8
A Music Score Rendering Engine
Functions
Miscellaneous

Functions

void GuidoGetVersionNums (int *major, int *minor, int *sub)
 Gives the library version number as three integers. More...
 
const char * GuidoGetVersionStr ()
 Gives the library version number as a string. More...
 
GuidoErrCode GuidoCheckVersionNums (int major, int minor, int sub)
 Checks a required library version number. More...
 
float GuidoGetLineSpace ()
 Gives the distance between two staff lines. More...
 
GuidoErrCode GuidoMarkVoice (ARHandler inHandleAR, int voicenum, const GuidoDate &date, const GuidoDate &duration, unsigned char red, unsigned char green, unsigned char blue)
 Gives a color to all notes of a voice between a given time interval. More...
 
GuidoErrCode GuidoSetSymbolPath (ARHandler inHandleAR, const std::vector< std::string > &inPaths)
 Makes the correspondance between an ARMusic and a path. More...
 
GuidoErrCode GuidoGetSymbolPath (const ARHandler inHandleAR, std::vector< std::string > &inPathVector)
 Returns the path corresponding to an AR. More...
 

Detailed Description

Includes various functions for version management and for conversions. The number of version functions is due to historical reasons.

Function Documentation

◆ GuidoCheckVersionNums()

GuidoErrCode GuidoCheckVersionNums ( int  major,
int  minor,
int  sub 
)

Checks a required library version number.

Parameters
majorthe major revision number.
minorthe minor revision number.
subthe sub revision number.
Returns
noErr if the library version number is greater or equal to the version number passed as argument.
otherwise guidoErrActionFailed.

◆ GuidoGetLineSpace()

float GuidoGetLineSpace ( )

Gives the distance between two staff lines.

This value is constant (= 50). It does not depend on the context, it will probably never change in future versions of the library.

Returns
the distance between two lines of staff, in Guido internal units.

◆ GuidoGetSymbolPath()

GuidoErrCode GuidoGetSymbolPath ( const ARHandler  inHandleAR,
std::vector< std::string > &  inPathVector 
)

Returns the path corresponding to an AR.

Parameters
inHandleARthe handle given to extract its path.
inPathVectorthe vector to be filled
Returns
the returned path.
noErr if the association has been made with success
otherwise guidoErrActionFailed.

◆ GuidoGetVersionNums()

void GuidoGetVersionNums ( int *  major,
int *  minor,
int *  sub 
)

Gives the library version number as three integers.

Version number format is MAJOR.MINOR.SUB

Parameters
majoron output: the major revision number.
minoron ouput: the minor revision number.
subon ouput: the sub revision number.
Returns
a Guido error code.

◆ GuidoGetVersionStr()

const char* GuidoGetVersionStr ( )

Gives the library version number as a string.

Returns
the version numebr as a string.

◆ GuidoMarkVoice()

GuidoErrCode GuidoMarkVoice ( ARHandler  inHandleAR,
int  voicenum,
const GuidoDate date,
const GuidoDate duration,
unsigned char  red,
unsigned char  green,
unsigned char  blue 
)

Gives a color to all notes of a voice between a given time interval.

Note
Introduced for GUIDO/MIR; Allows the user to see where a musical theme appears in a voice.
Parameters
inHandleARa Guido opaque handle to an AR structure.
voicenumindex of the voice to mark, starting from 1
datethe date where the color-marking must begin (whole note = 1)
durationthe duration that must be covered by the color marking.
redthe red component of the marking color, from 0 to 255.
greengreen color component.
blueblue color component.
Returns
a Guido error code.

◆ GuidoSetSymbolPath()

GuidoErrCode GuidoSetSymbolPath ( ARHandler  inHandleAR,
const std::vector< std::string > &  inPaths 
)

Makes the correspondance between an ARMusic and a path.

Parameters
inHandleARthe destination ARHandler.
inPathsthe path to associate.
Returns
noErr if the association has been made with success
otherwise guidoErrActionFailed.

Guido Project Copyright © 2019 Grame-CNCM