|
@@ -1,10 +1,10 @@
|
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
|
|
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
|
|
|
|
|
|
-.. _class_FixedMaterial:
|
|
|
|
|
|
+.. _class_FixedSpatialMaterial:
|
|
|
|
|
|
-FixedMaterial
|
|
|
|
-=============
|
|
|
|
|
|
+FixedSpatialMaterial
|
|
|
|
+====================
|
|
|
|
|
|
**Inherits:** :ref:`Material<class_material>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
|
**Inherits:** :ref:`Material<class_material>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
|
|
|
|
|
@@ -18,35 +18,35 @@ Simple Material with a fixed parameter set.
|
|
Member Functions
|
|
Member Functions
|
|
----------------
|
|
----------------
|
|
|
|
|
|
-+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
-| :ref:`bool<class_bool>` | :ref:`get_fixed_flag<class_FixedMaterial_get_fixed_flag>` **(** :ref:`int<class_int>` flag **)** const |
|
|
|
|
-+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
-| :ref:`int<class_int>` | :ref:`get_light_shader<class_FixedMaterial_get_light_shader>` **(** **)** const |
|
|
|
|
-+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
-| void | :ref:`get_parameter<class_FixedMaterial_get_parameter>` **(** :ref:`int<class_int>` param **)** const |
|
|
|
|
-+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
-| :ref:`float<class_float>` | :ref:`get_point_size<class_FixedMaterial_get_point_size>` **(** **)** const |
|
|
|
|
-+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
-| :ref:`int<class_int>` | :ref:`get_texcoord_mode<class_FixedMaterial_get_texcoord_mode>` **(** :ref:`int<class_int>` param **)** const |
|
|
|
|
-+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
-| :ref:`Texture<class_texture>` | :ref:`get_texture<class_FixedMaterial_get_texture>` **(** :ref:`int<class_int>` param **)** const |
|
|
|
|
-+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
-| :ref:`Transform<class_transform>` | :ref:`get_uv_transform<class_FixedMaterial_get_uv_transform>` **(** **)** const |
|
|
|
|
-+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
-| void | :ref:`set_fixed_flag<class_FixedMaterial_set_fixed_flag>` **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)** |
|
|
|
|
-+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
-| void | :ref:`set_light_shader<class_FixedMaterial_set_light_shader>` **(** :ref:`int<class_int>` shader **)** |
|
|
|
|
-+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
-| void | :ref:`set_parameter<class_FixedMaterial_set_parameter>` **(** :ref:`int<class_int>` param, :ref:`Variant<class_variant>` value **)** |
|
|
|
|
-+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
-| void | :ref:`set_point_size<class_FixedMaterial_set_point_size>` **(** :ref:`float<class_float>` size **)** |
|
|
|
|
-+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
-| void | :ref:`set_texcoord_mode<class_FixedMaterial_set_texcoord_mode>` **(** :ref:`int<class_int>` param, :ref:`int<class_int>` mode **)** |
|
|
|
|
-+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
-| void | :ref:`set_texture<class_FixedMaterial_set_texture>` **(** :ref:`int<class_int>` param, :ref:`Texture<class_texture>` texture **)** |
|
|
|
|
-+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
-| void | :ref:`set_uv_transform<class_FixedMaterial_set_uv_transform>` **(** :ref:`Transform<class_transform>` transform **)** |
|
|
|
|
-+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
|
|
++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
+| :ref:`bool<class_bool>` | :ref:`get_fixed_flag<class_FixedSpatialMaterial_get_fixed_flag>` **(** :ref:`int<class_int>` flag **)** const |
|
|
|
|
++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
+| :ref:`int<class_int>` | :ref:`get_light_shader<class_FixedSpatialMaterial_get_light_shader>` **(** **)** const |
|
|
|
|
++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
+| void | :ref:`get_parameter<class_FixedSpatialMaterial_get_parameter>` **(** :ref:`int<class_int>` param **)** const |
|
|
|
|
++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
+| :ref:`float<class_float>` | :ref:`get_point_size<class_FixedSpatialMaterial_get_point_size>` **(** **)** const |
|
|
|
|
++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
+| :ref:`int<class_int>` | :ref:`get_texcoord_mode<class_FixedSpatialMaterial_get_texcoord_mode>` **(** :ref:`int<class_int>` param **)** const |
|
|
|
|
++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
+| :ref:`Texture<class_texture>` | :ref:`get_texture<class_FixedSpatialMaterial_get_texture>` **(** :ref:`int<class_int>` param **)** const |
|
|
|
|
++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
+| :ref:`Transform<class_transform>` | :ref:`get_uv_transform<class_FixedSpatialMaterial_get_uv_transform>` **(** **)** const |
|
|
|
|
++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
+| void | :ref:`set_fixed_flag<class_FixedSpatialMaterial_set_fixed_flag>` **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)** |
|
|
|
|
++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
+| void | :ref:`set_light_shader<class_FixedSpatialMaterial_set_light_shader>` **(** :ref:`int<class_int>` shader **)** |
|
|
|
|
++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
+| void | :ref:`set_parameter<class_FixedSpatialMaterial_set_parameter>` **(** :ref:`int<class_int>` param, :ref:`Variant<class_variant>` value **)** |
|
|
|
|
++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
+| void | :ref:`set_point_size<class_FixedSpatialMaterial_set_point_size>` **(** :ref:`float<class_float>` size **)** |
|
|
|
|
++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
+| void | :ref:`set_texcoord_mode<class_FixedSpatialMaterial_set_texcoord_mode>` **(** :ref:`int<class_int>` param, :ref:`int<class_int>` mode **)** |
|
|
|
|
++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
+| void | :ref:`set_texture<class_FixedSpatialMaterial_set_texture>` **(** :ref:`int<class_int>` param, :ref:`Texture<class_texture>` texture **)** |
|
|
|
|
++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
+| void | :ref:`set_uv_transform<class_FixedSpatialMaterial_set_uv_transform>` **(** :ref:`Transform<class_transform>` transform **)** |
|
|
|
|
++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
|
|
Numeric Constants
|
|
Numeric Constants
|
|
-----------------
|
|
-----------------
|
|
@@ -76,78 +76,78 @@ Numeric Constants
|
|
Description
|
|
Description
|
|
-----------
|
|
-----------
|
|
|
|
|
|
-FixedMaterial is a simple type of material :ref:`Resource<class_resource>`, which contains a fixed amount of parameters. It is the only type of material supported in fixed-pipeline devices and APIs. It is also an often a better alternative to :ref:`ShaderMaterial<class_shadermaterial>` for most simple use cases.
|
|
|
|
|
|
+FixedSpatialMaterial is a simple type of material :ref:`Resource<class_resource>`, which contains a fixed amount of parameters. It is the only type of material supported in fixed-pipeline devices and APIs. It is also an often a better alternative to :ref:`ShaderMaterial<class_shadermaterial>` for most simple use cases.
|
|
|
|
|
|
Member Function Description
|
|
Member Function Description
|
|
---------------------------
|
|
---------------------------
|
|
|
|
|
|
-.. _class_FixedMaterial_get_fixed_flag:
|
|
|
|
|
|
+.. _class_FixedSpatialMaterial_get_fixed_flag:
|
|
|
|
|
|
- :ref:`bool<class_bool>` **get_fixed_flag** **(** :ref:`int<class_int>` flag **)** const
|
|
- :ref:`bool<class_bool>` **get_fixed_flag** **(** :ref:`int<class_int>` flag **)** const
|
|
|
|
|
|
-.. _class_FixedMaterial_get_light_shader:
|
|
|
|
|
|
+.. _class_FixedSpatialMaterial_get_light_shader:
|
|
|
|
|
|
- :ref:`int<class_int>` **get_light_shader** **(** **)** const
|
|
- :ref:`int<class_int>` **get_light_shader** **(** **)** const
|
|
|
|
|
|
-.. _class_FixedMaterial_get_parameter:
|
|
|
|
|
|
+.. _class_FixedSpatialMaterial_get_parameter:
|
|
|
|
|
|
- void **get_parameter** **(** :ref:`int<class_int>` param **)** const
|
|
- void **get_parameter** **(** :ref:`int<class_int>` param **)** const
|
|
|
|
|
|
Return a parameter, parameters are defined in the PARAM\_\* enum. The type of each parameter may change, so it's best to check the enum.
|
|
Return a parameter, parameters are defined in the PARAM\_\* enum. The type of each parameter may change, so it's best to check the enum.
|
|
|
|
|
|
-.. _class_FixedMaterial_get_point_size:
|
|
|
|
|
|
+.. _class_FixedSpatialMaterial_get_point_size:
|
|
|
|
|
|
- :ref:`float<class_float>` **get_point_size** **(** **)** const
|
|
- :ref:`float<class_float>` **get_point_size** **(** **)** const
|
|
|
|
|
|
-.. _class_FixedMaterial_get_texcoord_mode:
|
|
|
|
|
|
+.. _class_FixedSpatialMaterial_get_texcoord_mode:
|
|
|
|
|
|
- :ref:`int<class_int>` **get_texcoord_mode** **(** :ref:`int<class_int>` param **)** const
|
|
- :ref:`int<class_int>` **get_texcoord_mode** **(** :ref:`int<class_int>` param **)** const
|
|
|
|
|
|
Return the texture coordinate mode. Each texture param (from the PARAM\_\* enum) has one. It defines how the textures are mapped to the object.
|
|
Return the texture coordinate mode. Each texture param (from the PARAM\_\* enum) has one. It defines how the textures are mapped to the object.
|
|
|
|
|
|
-.. _class_FixedMaterial_get_texture:
|
|
|
|
|
|
+.. _class_FixedSpatialMaterial_get_texture:
|
|
|
|
|
|
- :ref:`Texture<class_texture>` **get_texture** **(** :ref:`int<class_int>` param **)** const
|
|
- :ref:`Texture<class_texture>` **get_texture** **(** :ref:`int<class_int>` param **)** const
|
|
|
|
|
|
-Return a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see :ref:`set_texcoord_mode<class_FixedMaterial_set_texcoord_mode>`).
|
|
|
|
|
|
+Return a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see :ref:`set_texcoord_mode<class_FixedSpatialMaterial_set_texcoord_mode>`).
|
|
|
|
|
|
-.. _class_FixedMaterial_get_uv_transform:
|
|
|
|
|
|
+.. _class_FixedSpatialMaterial_get_uv_transform:
|
|
|
|
|
|
- :ref:`Transform<class_transform>` **get_uv_transform** **(** **)** const
|
|
- :ref:`Transform<class_transform>` **get_uv_transform** **(** **)** const
|
|
|
|
|
|
Returns the special transform used to post-transform UV coordinates of the uv_xform texcoord mode: TEXCOORD_UV_TRANSFORM.
|
|
Returns the special transform used to post-transform UV coordinates of the uv_xform texcoord mode: TEXCOORD_UV_TRANSFORM.
|
|
|
|
|
|
-.. _class_FixedMaterial_set_fixed_flag:
|
|
|
|
|
|
+.. _class_FixedSpatialMaterial_set_fixed_flag:
|
|
|
|
|
|
- void **set_fixed_flag** **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)**
|
|
- void **set_fixed_flag** **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)**
|
|
|
|
|
|
-.. _class_FixedMaterial_set_light_shader:
|
|
|
|
|
|
+.. _class_FixedSpatialMaterial_set_light_shader:
|
|
|
|
|
|
- void **set_light_shader** **(** :ref:`int<class_int>` shader **)**
|
|
- void **set_light_shader** **(** :ref:`int<class_int>` shader **)**
|
|
|
|
|
|
-.. _class_FixedMaterial_set_parameter:
|
|
|
|
|
|
+.. _class_FixedSpatialMaterial_set_parameter:
|
|
|
|
|
|
- void **set_parameter** **(** :ref:`int<class_int>` param, :ref:`Variant<class_variant>` value **)**
|
|
- void **set_parameter** **(** :ref:`int<class_int>` param, :ref:`Variant<class_variant>` value **)**
|
|
|
|
|
|
Set a parameter, parameters are defined in the PARAM\_\* enum. The type of each parameter may change, so it's best to check the enum.
|
|
Set a parameter, parameters are defined in the PARAM\_\* enum. The type of each parameter may change, so it's best to check the enum.
|
|
|
|
|
|
-.. _class_FixedMaterial_set_point_size:
|
|
|
|
|
|
+.. _class_FixedSpatialMaterial_set_point_size:
|
|
|
|
|
|
- void **set_point_size** **(** :ref:`float<class_float>` size **)**
|
|
- void **set_point_size** **(** :ref:`float<class_float>` size **)**
|
|
|
|
|
|
-.. _class_FixedMaterial_set_texcoord_mode:
|
|
|
|
|
|
+.. _class_FixedSpatialMaterial_set_texcoord_mode:
|
|
|
|
|
|
- void **set_texcoord_mode** **(** :ref:`int<class_int>` param, :ref:`int<class_int>` mode **)**
|
|
- void **set_texcoord_mode** **(** :ref:`int<class_int>` param, :ref:`int<class_int>` mode **)**
|
|
|
|
|
|
Set the texture coordinate mode. Each texture param (from the PARAM\_\* enum) has one. It defines how the textures are mapped to the object.
|
|
Set the texture coordinate mode. Each texture param (from the PARAM\_\* enum) has one. It defines how the textures are mapped to the object.
|
|
|
|
|
|
-.. _class_FixedMaterial_set_texture:
|
|
|
|
|
|
+.. _class_FixedSpatialMaterial_set_texture:
|
|
|
|
|
|
- void **set_texture** **(** :ref:`int<class_int>` param, :ref:`Texture<class_texture>` texture **)**
|
|
- void **set_texture** **(** :ref:`int<class_int>` param, :ref:`Texture<class_texture>` texture **)**
|
|
|
|
|
|
-Set a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see :ref:`set_texcoord_mode<class_FixedMaterial_set_texcoord_mode>`).
|
|
|
|
|
|
+Set a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see :ref:`set_texcoord_mode<class_FixedSpatialMaterial_set_texcoord_mode>`).
|
|
|
|
|
|
-.. _class_FixedMaterial_set_uv_transform:
|
|
|
|
|
|
+.. _class_FixedSpatialMaterial_set_uv_transform:
|
|
|
|
|
|
- void **set_uv_transform** **(** :ref:`Transform<class_transform>` transform **)**
|
|
- void **set_uv_transform** **(** :ref:`Transform<class_transform>` transform **)**
|
|
|
|
|