diff options
author | gman@google.com <gman@google.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2009-08-05 04:15:12 +0000 |
---|---|---|
committer | gman@google.com <gman@google.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2009-08-05 04:15:12 +0000 |
commit | 96ba3f3624defbbb523023d3e731d56793083927 (patch) | |
tree | 7ec64d17aaa699c22d2fc76d9801b435f6a2baf7 /o3d/plugin/idl | |
parent | cf066e493d140b20125adf2335f8b891d7e4b536 (diff) | |
download | chromium_src-96ba3f3624defbbb523023d3e731d56793083927.zip chromium_src-96ba3f3624defbbb523023d3e731d56793083927.tar.gz chromium_src-96ba3f3624defbbb523023d3e731d56793083927.tar.bz2 |
Added default values to property documentation.
Fixed a few more docs issues.
Review URL: http://codereview.chromium.org/159894
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@22463 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'o3d/plugin/idl')
-rw-r--r-- | o3d/plugin/idl/buffer.idl | 8 | ||||
-rw-r--r-- | o3d/plugin/idl/canvas_paint.idl | 5 | ||||
-rw-r--r-- | o3d/plugin/idl/canvas_shader.idl | 4 | ||||
-rw-r--r-- | o3d/plugin/idl/clear_buffer.idl | 6 | ||||
-rw-r--r-- | o3d/plugin/idl/client.idl | 3 | ||||
-rw-r--r-- | o3d/plugin/idl/counter.idl | 21 | ||||
-rw-r--r-- | o3d/plugin/idl/curve.idl | 7 | ||||
-rw-r--r-- | o3d/plugin/idl/draw_context.idl | 2 | ||||
-rw-r--r-- | o3d/plugin/idl/draw_element.idl | 8 | ||||
-rw-r--r-- | o3d/plugin/idl/draw_pass.idl | 2 | ||||
-rw-r--r-- | o3d/plugin/idl/element.idl | 4 | ||||
-rw-r--r-- | o3d/plugin/idl/function.idl | 3 | ||||
-rw-r--r-- | o3d/plugin/idl/matrix4_axis_rotation.idl | 5 | ||||
-rw-r--r-- | o3d/plugin/idl/matrix4_composition.idl | 4 | ||||
-rw-r--r-- | o3d/plugin/idl/matrix4_scale.idl | 4 | ||||
-rw-r--r-- | o3d/plugin/idl/matrix4_translation.idl | 4 | ||||
-rw-r--r-- | o3d/plugin/idl/named.idl | 1 | ||||
-rw-r--r-- | o3d/plugin/idl/param.idl | 14 | ||||
-rw-r--r-- | o3d/plugin/idl/param_operation.idl | 34 | ||||
-rw-r--r-- | o3d/plugin/idl/primitive.idl | 4 | ||||
-rw-r--r-- | o3d/plugin/idl/render_node.idl | 5 | ||||
-rw-r--r-- | o3d/plugin/idl/sampler.idl | 8 | ||||
-rw-r--r-- | o3d/plugin/idl/transform.idl | 3 | ||||
-rw-r--r-- | o3d/plugin/idl/viewport.idl | 15 |
24 files changed, 139 insertions, 35 deletions
diff --git a/o3d/plugin/idl/buffer.idl b/o3d/plugin/idl/buffer.idl index f639934..83a4c6a 100644 --- a/o3d/plugin/idl/buffer.idl +++ b/o3d/plugin/idl/buffer.idl @@ -144,8 +144,8 @@ class Buffer : NamedObject { %[ VertexBufferBase is a the base class for both VertexBuffer and SourceBuffer - \sa VertexBuffer - \sa SourceBuffer + \sa o3d.VertexBuffer + \sa o3d.SourceBuffer %] [nocpp, include="core/cross/buffer.h"] class VertexBufferBase : Buffer { @@ -344,7 +344,7 @@ class VertexBufferBase : Buffer { (e.g. vertex positions, normals, colors, etc). A VertexBuffer can be rendered directly by the GPU. - \sa SourceBuffer + \sa o3d.SourceBuffer %] [nocpp, include="core/cross/buffer.h"] class VertexBuffer : VertexBufferBase { @@ -357,7 +357,7 @@ class VertexBuffer : VertexBufferBase { A SourceBuffer is the source for operations like skinning and morph targets. It can not be directly rendered by the GPU. - \sa VertexBuffer + \sa o3d.VertexBuffer %] [nocpp, include="core/cross/buffer.h"] class SourceBuffer : VertexBufferBase { diff --git a/o3d/plugin/idl/canvas_paint.idl b/o3d/plugin/idl/canvas_paint.idl index c6f9f9f..4cc7951 100644 --- a/o3d/plugin/idl/canvas_paint.idl +++ b/o3d/plugin/idl/canvas_paint.idl @@ -141,27 +141,32 @@ class CanvasPaint : ParamObject { %[ The color used for all the draw operations using this paint. + Default = [0, 0, 0, 1]. %] [getter, setter] Float4 color; %[ The size of the font used for drawing text. + Default = 10. %] [getter, setter] float text_size; %[ The font typeface used for drawing text. Passing an empty string will revert to the default font. + Default = "". %] [getter, setter] String text_typeface; %[ The style applied to the text (e.g. italic, bold, etc) + Default = NORMAL. %] [getter, setter] Style text_style; %[ The alignment mode used for drawing text. + Default = LEFT. %] [getter, setter] TextAlign text_align; diff --git a/o3d/plugin/idl/canvas_shader.idl b/o3d/plugin/idl/canvas_shader.idl index 252836b..daa3399 100644 --- a/o3d/plugin/idl/canvas_shader.idl +++ b/o3d/plugin/idl/canvas_shader.idl @@ -62,17 +62,20 @@ more colors need to be specified for the gradient. class CanvasLinearGradient : CanvasShader { %[ The start point of this gradient. + Default = [0, 0]. %] [getter, setter] Float2 start_point; %[ The end point of this gradient. + Default = [0, 0]. %] [getter, setter] Float2 end_point; %[ The array of colors to be distributed between the two points in RBGA format stored as an array of [r, g, b, a] colors. + Default = [[0, 0, 0, 1], [0, 0, 0, 1]]. %] [getter, setter] Float4[] colors; @@ -87,6 +90,7 @@ class CanvasLinearGradient : CanvasShader { %[ The TileMode of this gradient which controls how the gradient pattern repeats. + Default = REPEAT. %] [getter, setter] TileMode tile_mode; diff --git a/o3d/plugin/idl/clear_buffer.idl b/o3d/plugin/idl/clear_buffer.idl index 78dc176..5b27e5a 100644 --- a/o3d/plugin/idl/clear_buffer.idl +++ b/o3d/plugin/idl/clear_buffer.idl @@ -50,34 +50,40 @@ namespace o3d { : RenderNode { %[ The color to clear the buffer in RGBA Float4 format. + Default = [0, 0, 0, 1] %] [getter, setter] Float4 clear_color; %[ true clears the current render target's color buffer to the clear color. false does not clear the color buffer. + Default = true. %] [getter, setter] bool clear_color_flag_; %[ The value to clear the depth buffer (0.0 to 1.0) + Default = 1. %] [getter, setter] float clear_depth_; %[ true clears the current render target's depth buffer to the clear depth value. false does not clear the depth buffer. + Default = true. %] [getter, setter] bool clear_depth_flag_; %[ The value to clear the stencil buffer to (0 - 255). + Default = 0. %] [getter, setter] int clear_stencil_; %[ true clears the current render target's stencil buffer to the clear stencil value. false does not clear the stencil buffer + Default = true. %] [getter, setter] bool clear_stencil_flag_; diff --git a/o3d/plugin/idl/client.idl b/o3d/plugin/idl/client.idl index 80568c7..c4c1054 100644 --- a/o3d/plugin/idl/client.idl +++ b/o3d/plugin/idl/client.idl @@ -380,7 +380,7 @@ class Client { \param type Type of event to set callback for. \param handler Function to call on event. - \sa Event for a list of event + \sa o3d.Event %] void SetEventCallback(String type, EventCallback? handler); @@ -494,6 +494,7 @@ class Client { %[ Gets / Sets the cursor's shape. + Default = DEFAULT. %] [userglue_getter, userglue_setter, getter, setter, plugin_data] Cursor::CursorType cursor; diff --git a/o3d/plugin/idl/counter.idl b/o3d/plugin/idl/counter.idl index be594cb..7cc5d20 100644 --- a/o3d/plugin/idl/counter.idl +++ b/o3d/plugin/idl/counter.idl @@ -69,32 +69,38 @@ typedef NumberArray[] NumberArrayArray; }; %[ - Whether or not this counter is running. Default = true. + Whether or not this counter is running. + Default = true. %] [getter, setter] bool running_; %[ - Which direction this counter is counting. Default = true. + Which direction this counter is counting. + Default = true. %] [getter, setter] bool forward_; %[ - The start count for this counter. Default = 0. + The start count for this counter. + Default = 0. %] [getter, setter] float start_; %[ - The end count for this counter. Default = 0. + The end count for this counter. + Default = 0. %] [getter, setter] float end_; %[ - The current count value for this counter. Default = 0. + The current count value for this counter. + Default = 0. %] [getter] float count_; %[ - The current count mode for this counter. Default = CONTINUOUS. + The current count mode for this counter. + Default = CONTINUOUS. %] [getter, setter] CountMode count_mode_; @@ -137,7 +143,8 @@ typedef NumberArray[] NumberArrayArray; %[ A multiplier used when advancing the count. The default value is 1.0. For example you could set this to 0.5 to run the counter at half speed - or 2.0 to run it at double speed. Default = 1. + or 2.0 to run it at double speed. + Default = 1. %] [getter, setter] float multiplier_; diff --git a/o3d/plugin/idl/curve.idl b/o3d/plugin/idl/curve.idl index 66fb45b..2caf91d 100644 --- a/o3d/plugin/idl/curve.idl +++ b/o3d/plugin/idl/curve.idl @@ -142,17 +142,20 @@ class Curve : Function { %[ The behavior of the curve before the first key. + Default = CONSTANT. %] [getter, setter] Infinity pre_infinity; %[ The behavior of the curve after the last key. + Default = CONSTANT. %] [getter, setter] Infinity post_infinity; %[ Whether or not a cache is used to speed up evaluation of this Curve - \sa SetSampleRate + Default = true. + \sa o3d.Curve.setSampleRate %] [getter, setter] bool use_cache; @@ -164,7 +167,7 @@ class Curve : Function { The default is 1/30 (30hz). You can set it anywhere from 1/240th (240hz) to any larger value. Note: Setting the sample rate has the side effect of invalidating the cache thereby causing it to get rebuilt. - Must be 1/240 or greater. Default = 1/30 + Must be 1/240 or greater. Default = 1/30. %] [getter, setter, userglue_setter] float sample_rate; diff --git a/o3d/plugin/idl/draw_context.idl b/o3d/plugin/idl/draw_context.idl index 6add8a3..5141d37 100644 --- a/o3d/plugin/idl/draw_context.idl +++ b/o3d/plugin/idl/draw_context.idl @@ -47,6 +47,7 @@ namespace o3d { %[ The view matrix represents the viewing transformation, used to take vertices from world space to view space. + Default = Identity. %] [getter, setter] Vectormath::Aos::Matrix4 view; @@ -54,6 +55,7 @@ namespace o3d { The projection matrix represents the projection transformation, used to take vertices from view space to screen space. This matrix is usually an orthographic or perspective transformation. + Default = Identity. %] [getter, setter] Vectormath::Aos::Matrix4 projection; }; // DrawContext diff --git a/o3d/plugin/idl/draw_element.idl b/o3d/plugin/idl/draw_element.idl index 3178f86..5181f32 100644 --- a/o3d/plugin/idl/draw_element.idl +++ b/o3d/plugin/idl/draw_element.idl @@ -36,9 +36,9 @@ namespace o3d { You can override other Effect parameters by adding corresponding params to the DrawElement. - \sa Element - \sa Material - \sa Effect + \sa o3d.Element + \sa o3d.Material + \sa o3d.Effect @o3dparameter material ParamMaterial The material used to render this the Element that owns this DrawElement. @@ -47,7 +47,7 @@ namespace o3d { : ParamObject { %[ - The Material for this Draw Element. If it is null the material of owner will + The Material for this DrawElement. If it is null the material of owner will be used. %] [getter, setter] Material? material_; diff --git a/o3d/plugin/idl/draw_pass.idl b/o3d/plugin/idl/draw_pass.idl index b331209..c627151 100644 --- a/o3d/plugin/idl/draw_pass.idl +++ b/o3d/plugin/idl/draw_pass.idl @@ -46,6 +46,8 @@ namespace o3d { %[ The sort method for this DrawPass to draw the DrawList by. + Default = BY_PERFORMANCE. + \sa o3d.DrawList %] [getter, setter] DrawList::SortMethod sort_method_; }; // Material diff --git a/o3d/plugin/idl/element.idl b/o3d/plugin/idl/element.idl index 696272e..9e2a5f1 100644 --- a/o3d/plugin/idl/element.idl +++ b/o3d/plugin/idl/element.idl @@ -55,6 +55,7 @@ typedef DrawElement[] DrawElementArray; The BoundingBox for this element. If culling is on this bounding box will be tested against the view frustum of any draw context used to render this Element. + Default = [[0, 0, 0], [0, 0, 0]]. %] [getter, setter] BoundingBox bounding_box_; @@ -62,12 +63,14 @@ typedef DrawElement[] DrawElementArray; The z sort point for this element. If this Element is drawn by a DrawPass that is set to sort by z order this value will be multiplied by the worldViewProjection matrix to compute a z value to sort by. + Default = [0, 0, 0]. %] [getter, setter] Float3 z_sort_point; %[ The priority for this element. Used to sort if this Element is drawn by a DrawPass that is set to sort by priority. + Default = 0. %] [getter, setter] float priority_; @@ -75,6 +78,7 @@ typedef DrawElement[] DrawElementArray; The cull settings for this element. If true this Element will be culled by the bounding box above compared to the view frustum it is being rendered with. + Default = false. %] [getter, setter] bool cull_; diff --git a/o3d/plugin/idl/function.idl b/o3d/plugin/idl/function.idl index 64bf1e7..5f8a7f8 100644 --- a/o3d/plugin/idl/function.idl +++ b/o3d/plugin/idl/function.idl @@ -72,7 +72,8 @@ class Function : NamedObject { [nocpp, include="core/cross/function.h"] class FunctionEval : ParamObject { %[ - The input to the function + The input to the function. + Default = 0. %] [getter, setter] float input; diff --git a/o3d/plugin/idl/matrix4_axis_rotation.idl b/o3d/plugin/idl/matrix4_axis_rotation.idl index 207e086..aa78dcc 100644 --- a/o3d/plugin/idl/matrix4_axis_rotation.idl +++ b/o3d/plugin/idl/matrix4_axis_rotation.idl @@ -46,16 +46,19 @@ namespace o3d { class Matrix4AxisRotation : ParamObject { %[ The local rotation axis. This must be a unit vector. + Default = [0, 0, 0]. %] [getter, setter] Float3 axis; %[ The angle of rotation in radians. + Default = 0. %] [getter, setter] float angle; %[ - The input matrix. Identity by default. + The input matrix. + Default = Identity. %] [getter, setter] Vectormath::Aos::Matrix4 input_matrix; diff --git a/o3d/plugin/idl/matrix4_composition.idl b/o3d/plugin/idl/matrix4_composition.idl index 35a5d22..bd899b1 100644 --- a/o3d/plugin/idl/matrix4_composition.idl +++ b/o3d/plugin/idl/matrix4_composition.idl @@ -45,11 +45,13 @@ namespace o3d { class Matrix4Composition : ParamObject { %[ The local matrix. + Default = Identity. %] [getter, setter] Vectormath::Aos::Matrix4 local_matrix; %[ - The input matrix. Identity by default. + The input matrix. + Default = Identity. %] [getter, setter] Vectormath::Aos::Matrix4 input_matrix; diff --git a/o3d/plugin/idl/matrix4_scale.idl b/o3d/plugin/idl/matrix4_scale.idl index 3b25089..a4766db2 100644 --- a/o3d/plugin/idl/matrix4_scale.idl +++ b/o3d/plugin/idl/matrix4_scale.idl @@ -44,11 +44,13 @@ namespace o3d { class Matrix4Scale : ParamObject { %[ The local scaling. + Default = [0, 0, 0]. %] [getter, setter] Float3 scale; %[ - The parent matrix. Identity by default. + The parent matrix. + Default = Identity. %] [getter, setter] Vectormath::Aos::Matrix4 input_matrix; diff --git a/o3d/plugin/idl/matrix4_translation.idl b/o3d/plugin/idl/matrix4_translation.idl index 7a1e812..673df67 100644 --- a/o3d/plugin/idl/matrix4_translation.idl +++ b/o3d/plugin/idl/matrix4_translation.idl @@ -44,11 +44,13 @@ namespace o3d { class Matrix4Translation : ParamObject { %[ The local translation. + Default = [0, 0, 0]. %] [getter, setter] Float3 translation; %[ - The input matrix. Identity by default. + The input matrix. + Default = Identity. %] [getter, setter] Vectormath::Aos::Matrix4 input_matrix; diff --git a/o3d/plugin/idl/named.idl b/o3d/plugin/idl/named.idl index 3401cfc..f73be6b 100644 --- a/o3d/plugin/idl/named.idl +++ b/o3d/plugin/idl/named.idl @@ -93,6 +93,7 @@ class ObjectBase { class NamedObjectBase: ObjectBase { %[ The object's name. + Default = "". %] [getter] String name; diff --git a/o3d/plugin/idl/param.idl b/o3d/plugin/idl/param.idl index 4e4c36d..e57f8fe 100644 --- a/o3d/plugin/idl/param.idl +++ b/o3d/plugin/idl/param.idl @@ -115,6 +115,7 @@ typedef Param[] ParamVector; %[ A Param class which stores a single float. + Default Value = 0. %] [nocpp, include="core/cross/param.h"] class ParamFloat : Param { %[ @@ -125,10 +126,11 @@ typedef Param[] ParamVector; %[ A Param class which stores a Float2. + Default Value = [0, 0]. %] [nocpp, include="core/cross/param.h"] class ParamFloat2 : Param { %[ - Sets the Float2 stored by the Param by an array of 2 numbers. + The Float2 stored by the Param as an array of 2 numbers. %] [setter, getter, property=rw, nocpp] Float2 value; @@ -150,10 +152,11 @@ typedef Param[] ParamVector; %[ A Param class which stores a Float3. + Default Value = [0, 0, 0]. %] [nocpp, include="core/cross/param.h"] class ParamFloat3 : Param { %[ - Sets the Float3 stored by the Param by an array of 3 numbers. + The Float3 stored by the Param as an array of 3 numbers. %] [setter, getter, property=rw, nocpp] Float3 value; @@ -177,10 +180,11 @@ typedef Param[] ParamVector; %[ A Param class which stores a Float4. + Default Value = [0, 0, 0, 0]. %] [nocpp, include="core/cross/param.h"] class ParamFloat4 : Param { %[ - Sets the Float4 stored by the Param by an array of 4 numbers. + The Float4 stored by the Param as an array of 4 numbers. %] [setter, getter, property=rw, nocpp] Float4 value; @@ -206,6 +210,7 @@ typedef Param[] ParamVector; %[ A Param class which stores a 4-by-4 matrix. + Default Value = Identity. %] [nocpp, include="core/cross/param.h"] class ParamMatrix4 : Param { %[ @@ -217,6 +222,7 @@ typedef Param[] ParamVector; %[ A Param class which stores an integer. + Default Value = 0. %] [nocpp, include="core/cross/param.h"] class ParamInteger : Param { %[ @@ -227,6 +233,7 @@ typedef Param[] ParamVector; %[ A Param class which stores a boolean. + Default Value = false. %] [nocpp, include="core/cross/param.h"] class ParamBoolean : Param { %[ @@ -237,6 +244,7 @@ typedef Param[] ParamVector; %[ A Param which stores a string. + Default Value = "". %] [nocpp, include="core/cross/param.h"] class ParamString : Param { %[ diff --git a/o3d/plugin/idl/param_operation.idl b/o3d/plugin/idl/param_operation.idl index 6c97be5..ddb086e 100644 --- a/o3d/plugin/idl/param_operation.idl +++ b/o3d/plugin/idl/param_operation.idl @@ -43,11 +43,13 @@ namespace o3d { class ParamOp2FloatsToFloat2 : ParamObject { %[ The first value for the Float2. + Default = 0. %] [getter, setter] float input_0; %[ The second value for the Float2. + Default = 0. %] [getter, setter] float input_1; @@ -70,16 +72,19 @@ class ParamOp2FloatsToFloat2 : ParamObject { class ParamOp3FloatsToFloat3 : ParamObject { %[ The first value for the Float3. + Default = 0. %] [getter, setter] float input_0; %[ The second value for the Float3. + Default = 0. %] [getter, setter] float input_1; %[ The third value for the Float3. + Default = 0. %] [getter, setter] float input_2; @@ -103,21 +108,25 @@ class ParamOp3FloatsToFloat3 : ParamObject { class ParamOp4FloatsToFloat4 : ParamObject { %[ The first value for the Float4. + Default = 0. %] [getter, setter] float input_0; %[ The second value for the Float4. + Default = 0. %] [getter, setter] float input_1; %[ The third value for the Float4. + Default = 0. %] [getter, setter] float input_2; %[ The fourth value for the Float4. + Default = 0. %] [getter, setter] float input_3; @@ -159,81 +168,97 @@ class ParamOp4FloatsToFloat4 : ParamObject { class ParamOp16FloatsToMatrix4 : ParamObject { %[ The first value for the Float4. + Default = 0. %] [getter, setter] float input_0; %[ The second value for the Float4. + Default = 0. %] [getter, setter] float input_1; %[ The third value for the Float4. + Default = 0. %] [getter, setter] float input_2; %[ The fourth value for the Float4. + Default = 0. %] [getter, setter] float input_3; %[ The fifth value for the Float4. + Default = 0. %] [getter, setter] float input_4; %[ The sixth value for the Float4. + Default = 0. %] [getter, setter] float input_5; %[ The seventh value for the Float4. + Default = 0. %] [getter, setter] float input_6; %[ The eighth value for the Float4. + Default = 0. %] [getter, setter] float input_7; %[ The ninth value for the Float4. + Default = 0. %] [getter, setter] float input_8; %[ The tenth value for the Float4. + Default = 0. %] [getter, setter] float input_9; %[ The eleventh value for the Float4. + Default = 0. %] [getter, setter] float input_10; %[ The twelfth value for the Float4. + Default = 0. %] [getter, setter] float input_11; %[ The thirteenth value for the Float4. + Default = 0. %] [getter, setter] float input_12; %[ The fourteenth value for the Float4. + Default = 0. %] [getter, setter] float input_13; %[ The fifteenth value for the Float4. + Default = 0. %] [getter, setter] float input_14; %[ The sixteenth value for the Float4. + Default = 0. %] [getter, setter] float input_15; @@ -265,46 +290,55 @@ class ParamOp16FloatsToMatrix4 : ParamObject { class TRSToMatrix4 : ParamObject { %[ The x translation for the Matrix4. + Default = 0. %] [getter, setter] float translate_x; %[ The y translation for the Matrix4. + Default = 0. %] [getter, setter] float translate_y; %[ The z translation for the Matrix4. + Default = 0. %] [getter, setter] float translate_z; %[ The x rotation for the Matrix4. + Default = 0. %] [getter, setter] float rotate_x; %[ The y rotation for the Matrix4. + Default = 0. %] [getter, setter] float rotate_y; %[ The z rotation for the Matrix4. + Default = 0. %] [getter, setter] float rotate_z; %[ The x scale for the Matrix4. + Default = 0. %] [getter, setter] float scale_x; %[ The y scale for the Matrix4. + Default = 0. %] [getter, setter] float scale_y; %[ The z scale for the Matrix4. + Default = 0. %] [getter, setter] float scale_z; diff --git a/o3d/plugin/idl/primitive.idl b/o3d/plugin/idl/primitive.idl index 2f83535..cf32673 100644 --- a/o3d/plugin/idl/primitive.idl +++ b/o3d/plugin/idl/primitive.idl @@ -63,22 +63,26 @@ class Primitive : Element { %[ The type of primitive the primitive is (i.e., Primitive::POINTLIST, Primitive::LINELIST, Primitive::TRIANGLELIST, etc.) + Default = TRIANGLELIST. %] [getter, setter] Primitive::PrimitiveType primitive_type; %[ The number of vertices the primitive has. + Default = 0. %] [getter, setter] unsigned int number_vertices; %[ The number of rendering primitives (i.e., triangles, points, lines) the primitive has. + Default = 0. %] [getter, setter] unsigned int number_primitives; %[ The index of the first vertex to render. + Default = 0. %] [getter, setter] unsigned int start_index; diff --git a/o3d/plugin/idl/render_node.idl b/o3d/plugin/idl/render_node.idl index ee8b8b8..44696b8 100644 --- a/o3d/plugin/idl/render_node.idl +++ b/o3d/plugin/idl/render_node.idl @@ -45,13 +45,14 @@ namespace o3d { %[ Sets the priority of this render node. lower priorities are rendered first. + Default = 0. %] [getter, setter] float priority_; %[ Setting false skips this render node. Setting true processes this render - node. (ie, renders - whatever it's supposed to render) + node. (ie, renders whatever it's supposed to render) + Default = true. %] [getter, setter] bool active_; diff --git a/o3d/plugin/idl/sampler.idl b/o3d/plugin/idl/sampler.idl index 2f75ccc..a6608ed 100644 --- a/o3d/plugin/idl/sampler.idl +++ b/o3d/plugin/idl/sampler.idl @@ -82,45 +82,53 @@ class Sampler : ParamObject { %[ The texture address mode for the u coordinate. + Default = WRAP. %] [getter, setter] AddressMode address_mode_u_; %[ The texture address mode for the v coordinate. + Default = WRAP. %] [getter, setter] AddressMode address_mode_v_; %[ The texture address mode for the w coordinate. + Default = WRAP. %] [getter, setter] AddressMode address_mode_w_; %[ The magnification filter. Valid values for the mag filter are: POINT and LINEAR. + Default = LINEAR. %] [getter, setter] FilterType mag_filter_; %[ The minification filter. Valid values for the min filter are: POINT, LINEAR and ANISOTROPIC. + Default = LINEAR. %] [getter, setter] FilterType min_filter_; %[ The mipmap filter used during minification. Valid values for the mip filter are: NONE, POINT and LINEAR. + Default = LINEAR. %] [getter, setter] FilterType mip_filter_; %[ Color returned for texture coordinates outside the [0,1] range when the address mode is set to BORDER. + Default = [0, 0, 0, 0]. %] [getter, setter] Float4 border_color; %[ Degree of anisotropy used when the ANISOTROPIC filter type is used. + Default = 1. %] [getter, setter] int max_anisotropy_; diff --git a/o3d/plugin/idl/transform.idl b/o3d/plugin/idl/transform.idl index 3e1653a..bc359f2 100644 --- a/o3d/plugin/idl/transform.idl +++ b/o3d/plugin/idl/transform.idl @@ -52,6 +52,7 @@ typedef Shape[] ShapeArray; : ParamObject { %[ The Visibility for this transform. + Default = true. %] [getter, setter] bool visible_; @@ -168,6 +169,7 @@ typedef Shape[] ShapeArray; %[ Local transformation matrix. + Default = Identity. %] [getter, setter, nocpp] Vectormath::Aos::Matrix4 local_matrix; @@ -175,6 +177,7 @@ typedef Shape[] ShapeArray; The cull setting for this transform. If true this Transform will be culled by having its bounding box compared to the view frustum of any draw context it is used with. + Default = false. %] [getter, setter] bool cull_; diff --git a/o3d/plugin/idl/viewport.idl b/o3d/plugin/idl/viewport.idl index e9564a2..0e12f94 100644 --- a/o3d/plugin/idl/viewport.idl +++ b/o3d/plugin/idl/viewport.idl @@ -47,23 +47,24 @@ namespace o3d { : RenderNode { %[ The position and size to set the viewport in - [left, top, width, height] format. The default values - are (0.0, 0.0, 1.0, 1.0). In other words, the full area. + [left, top, width, height] format. Note: These values must describe a rectangle that is 100% inside the client - area. In other words, (0.5, 0.0, 1.0, 1.0) would describe an area that is + area. In other words, [0.5, 0.0, 1.0, 1.0] would describe an area that is 1/2 off right side of the screen. That is an invalid value and will be - clipped to (0.5, 0.0, 0.5, 1.0). + clipped to [0.5, 0.0, 0.5, 1.0]. - \sa Viewport + Default = [0.0, 0.0, 1.0, 1.0]. In other words, the full area. + + \sa o3d.Viewport %] [getter, setter] Float4 viewport; %[ The min Z and max Z depth range in [min Z, max Z] format. - The default values are [0.0, 1.0]. + Default = [0.0, 1.0]. - \sa Viewport + \sa o3d.Viewport %] [getter, setter] Float2 depth_range; }; // Viewport |