openfx-sys 0.1.0

Rust bindings for OpenFX
Documentation 
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
114
115
116
117
118
119
120
121
122
123
124
125

<?xml version="1.0"?>

<!--
This XML file is an example for a hypothetical OFX plugin 'someplugin'. It is there to illustrate the basics. 

Bruno Nicoletti

 -->

<!DOCTYPE OfxImageEffectResource SYSTEM "ofx.dtd">

<OfxImageEffectResource>
<!--
  Define the resource overrides for the plugin with the identifier 'someplugin'
-->
<OfxPlugin name="someplugin">

  <!--
    Define the resources overrides to be used for the host 'someHost' in the locale 'someLocale'
   -->
  <OfxResourceSet ofxHost="someHost" ofxLocale="someLocale">

     <!-- Set the user visible label on the plug-in -->
     <OfxPropLabel>SomePlugin</OfxPropLabel>


     <!-- redefine a message 
      -->
     <OfxMessage name="MyErrorMessage">Fool! I ain't getting in no plane.</OfxMessage>
      
     <!--
         Define default overrides that apply in all contexts (unless specified in a specific context)
      -->
     <OfxImageEffectContext name="default">

        <!-- relabel the source clip -->
        <OfxImageClip name = "Source">
	  <OfxPropLabel>Funky Source Clip</OfxPropLabel>
	</OfxImageClip>

	<!-- reset the defaults and rehint an integer -->
	<OfxParamTypeInteger name="someInt">
	  <OfxParamPropDefault><int>10</int></OfxParamPropDefault>
	  <OfxParamPropHint>This is a very nice integer.</OfxParamPropHint>
	</OfxParamTypeInteger>

	<!-- reset the defaults and rehint an 2D integer -->
	<OfxParamTypeInteger2D name="some2DInt">
	  <OfxParamPropDefault><int2>10 20</int2></OfxParamPropDefault>
	  <OfxParamPropHint>This is an even nicer integer.</OfxParamPropHint>
	</OfxParamTypeInteger2D>

     </OfxImageEffectContext>
     
     <!--
         Define default overrides that apply only in the generator context
      -->
     <OfxImageEffectContext name="OfxImageEffectContextGenerator">
     
        <!-- we are redefining the parameter hierarchy, this completely clobbers the old hierarchy -->
	<OfxParamHierarchy>
	   <OfxParam>intParam</OfxParam>
	   <OfxParamGroup>
		<OfxPropLabel>My Nice Group</OfxPropLabel>
		<OfxParam>some2DInt</OfxParam>
	   </OfxParamGroup>
	</OfxParamHierarchy>

	<!-- we are redefining the set of pages, this completely clobbers all pages -->
	<OfxParamPageSet>
	   <!-- new page, they appear in the order they are defined -->
	   <OfxParamPage>
	      <!-- name it -->
	      <OfxPropLabel>Main</OfxPropLabel>

	      <!-- put the first parameter in at the top left -->
	      <OfxParam>intParam</OfxParam>

	      <!-- skip a column -->
	      <OfxParam>OfxParamPageSkipColumn</OfxParam>

	      <!-- which puts this at the top of column two -->
	      <OfxParam>int2DParam</OfxParam>

	   </OfxParamPage>
	</OfxParamPageSet>

     </OfxImageEffectContext>

     <!--
         Define default overrides that apply only in the filter context
      -->
     <OfxImageEffectContext name="OfxImageEffectContextFilter">	
     
        <!-- reset the hint on our double param -->
	<OfxParamTypeDouble name="doubleParam">
	  <OfxParamPropHint>A double param that is only in the filter context.</OfxParamPropHint>
	</OfxParamTypeDouble>

        <!-- we are redefining the parameter hierarchy, this completely clobbers the old hierarchy -->
	<OfxParamHierarchy>
	   <OfxParam>intParam</OfxParam>
	   <OfxParam>doubleParam</OfxParam>
	   <OfxParamGroup>
		<OfxPropLabel>My Nice Group</OfxPropLabel>
		<OfxParam>some2DInt</OfxParam>
	   </OfxParamGroup>
	</OfxParamHierarchy>

	<!-- we are redefining the set of pages, this completely clobbers all pages -->
	<OfxParamPageSet>
	   <OfxParamPage>
	      <OfxPropLabel>Main</OfxPropLabel>
	      <OfxParam>intParam</OfxParam>
	      <OfxParam>doubleParam</OfxParam>
	      <OfxParam>OfxParamPageSkipColumn</OfxParam>
	      <OfxParam>int2DParam</OfxParam>
	   </OfxParamPage>
	</OfxParamPageSet>

     </OfxImageEffectContext>

  </OfxResourceSet>
</OfxPlugin>
</OfxImageEffectResource>