File: GraphicSynchronizerInterface.h

package info (click to toggle)
scilab 5.2.2-9
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 334,832 kB
  • ctags: 52,586
  • sloc: xml: 526,945; ansic: 223,590; fortran: 163,080; java: 56,934; cpp: 33,840; tcl: 27,936; sh: 20,397; makefile: 9,908; ml: 9,451; perl: 1,323; cs: 614; lisp: 30
file content (113 lines) | stat: -rw-r--r-- 3,175 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
/*
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2007 - INRIA - Jean-Baptiste Silvy 
 * desc : Interface to use class GraphicSynchronizer from C code
 * 
 * This file must be used under the terms of the CeCILL.
 * This source file is licensed as described in the file COPYING, which
 * you should have received as part of this distribution.  The terms
 * are also available at    
 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
 *
 */

#ifndef _GRAPHIC_SYNCHRONIZER_INTERFACE_H_
#define _GRAPHIC_SYNCHRONIZER_INTERFACE_H_

#ifdef __cplusplus
extern "C" {
#endif

#include "dynlib_renderer.h"
#include "ObjectStructure.h"

/**
 * Protect the data of a figure and its children from being accessed from an other thread.
 */
RENDERER_IMPEXP void startFigureDataWriting(sciPointObj * pFigure) ;

/**
 * Should be called after a call to startFigureDataWriting to remove figure locking.
 */
RENDERER_IMPEXP void endFigureDataWriting(sciPointObj * pFigure);

/**
 * Protect the data of a figure from being writen by an other thread.
 */
RENDERER_IMPEXP void startFigureDataReading(sciPointObj * pFigure);

/**
 * Should be called after a call to startFigureDataReading to remove figure locking.
 */
RENDERER_IMPEXP void endFigureDataReading(sciPointObj * pFigure);

/**
 * Protect the data of a figure from being writen or displayed by an other thread.
 */
RENDERER_IMPEXP void startFigureDataDisplaying(sciPointObj * pFigure);

/**
 * Should be called after a call to startFigureDataDisplaying to remove figure locking.
 */
RENDERER_IMPEXP void endFigureDataDisplaying(sciPointObj * pFigure);

/**
 * Protect all graphic hierarchy from being accessed from an other thread.
 */
RENDERER_IMPEXP void startGraphicDataWriting( void );

/**
 * Should be called after a call to startGraphicDataWriting.
 */
RENDERER_IMPEXP void endGraphicDataWriting( void );

/**
 * Protect all graphic hierarchy from being written by an other thread.
 */
RENDERER_IMPEXP void startGraphicDataReading( void );

/**
 * Should be called after a call to startGraphicDataWriting.
 */
RENDERER_IMPEXP void endGraphicDataReading( void );

/**
 * Protect all graphic hierarchy from being written by an other thread.
 */
RENDERER_IMPEXP void startGraphicDataDisplaying( void ) ;

/**
 * Should be called after a call to endFigureDataDisplaying.
 */
RENDERER_IMPEXP void endGraphicDataDisplaying( void ) ;

/**
 * Disable synchronization for a figure.
 * By default synchrnonization is enalbe
 * To be used with caution.
 */
RENDERER_IMPEXP void enableFigureSynchronization(sciPointObj * pFigure);

/**
 * Enable synchronization for a figure.
 * By default synchrnonization is enalbe
 * To be used with caution.
 */
RENDERER_IMPEXP void disableFigureSynchronization(sciPointObj * pFigure);

/**
 * To be called before any call to startGraphicData***
 * Allocates data needed by these functions.
 */
RENDERER_IMPEXP void createGraphicSynchronizer( void ) ;

/**
 * Deallocates data needed by startGraphicData*** functions.
 */
RENDERER_IMPEXP void destroyGraphicSynchronizer( void ) ;

#ifdef __cplusplus
}
#endif

#endif /* _GRAPHIC_SYNCHRONIZER_INTERFACE_H_ */