class_gltfspecgloss.rst 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFSpecGloss.xml.
  6. .. _class_GLTFSpecGloss:
  7. GLTFSpecGloss
  8. =============
  9. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. Archived GLTF extension for specular/glossy materials.
  11. Description
  12. -----------
  13. KHR_materials_pbrSpecularGlossiness is an archived GLTF extension. This means that it is deprecated and not recommended for new files. However, it is still supported for loading old files.
  14. Tutorials
  15. ---------
  16. - `KHR_materials_pbrSpecularGlossiness GLTF extension spec <https://github.com/KhronosGroup/glTF/blob/main/extensions/2.0/Archived/KHR_materials_pbrSpecularGlossiness>`__
  17. Properties
  18. ----------
  19. +---------------------------+----------------------------------------------------------------------+-----------------------+
  20. | :ref:`Color<class_Color>` | :ref:`diffuse_factor<class_GLTFSpecGloss_property_diffuse_factor>` | ``Color(1, 1, 1, 1)`` |
  21. +---------------------------+----------------------------------------------------------------------+-----------------------+
  22. | :ref:`Image<class_Image>` | :ref:`diffuse_img<class_GLTFSpecGloss_property_diffuse_img>` | |
  23. +---------------------------+----------------------------------------------------------------------+-----------------------+
  24. | :ref:`float<class_float>` | :ref:`gloss_factor<class_GLTFSpecGloss_property_gloss_factor>` | ``1.0`` |
  25. +---------------------------+----------------------------------------------------------------------+-----------------------+
  26. | :ref:`Image<class_Image>` | :ref:`spec_gloss_img<class_GLTFSpecGloss_property_spec_gloss_img>` | |
  27. +---------------------------+----------------------------------------------------------------------+-----------------------+
  28. | :ref:`Color<class_Color>` | :ref:`specular_factor<class_GLTFSpecGloss_property_specular_factor>` | ``Color(1, 1, 1, 1)`` |
  29. +---------------------------+----------------------------------------------------------------------+-----------------------+
  30. Property Descriptions
  31. ---------------------
  32. .. _class_GLTFSpecGloss_property_diffuse_factor:
  33. - :ref:`Color<class_Color>` **diffuse_factor**
  34. +-----------+---------------------------+
  35. | *Default* | ``Color(1, 1, 1, 1)`` |
  36. +-----------+---------------------------+
  37. | *Setter* | set_diffuse_factor(value) |
  38. +-----------+---------------------------+
  39. | *Getter* | get_diffuse_factor() |
  40. +-----------+---------------------------+
  41. The reflected diffuse factor of the material.
  42. ----
  43. .. _class_GLTFSpecGloss_property_diffuse_img:
  44. - :ref:`Image<class_Image>` **diffuse_img**
  45. +----------+------------------------+
  46. | *Setter* | set_diffuse_img(value) |
  47. +----------+------------------------+
  48. | *Getter* | get_diffuse_img() |
  49. +----------+------------------------+
  50. The diffuse texture.
  51. ----
  52. .. _class_GLTFSpecGloss_property_gloss_factor:
  53. - :ref:`float<class_float>` **gloss_factor**
  54. +-----------+-------------------------+
  55. | *Default* | ``1.0`` |
  56. +-----------+-------------------------+
  57. | *Setter* | set_gloss_factor(value) |
  58. +-----------+-------------------------+
  59. | *Getter* | get_gloss_factor() |
  60. +-----------+-------------------------+
  61. The glossiness or smoothness of the material.
  62. ----
  63. .. _class_GLTFSpecGloss_property_spec_gloss_img:
  64. - :ref:`Image<class_Image>` **spec_gloss_img**
  65. +----------+---------------------------+
  66. | *Setter* | set_spec_gloss_img(value) |
  67. +----------+---------------------------+
  68. | *Getter* | get_spec_gloss_img() |
  69. +----------+---------------------------+
  70. The specular-glossiness texture.
  71. ----
  72. .. _class_GLTFSpecGloss_property_specular_factor:
  73. - :ref:`Color<class_Color>` **specular_factor**
  74. +-----------+----------------------------+
  75. | *Default* | ``Color(1, 1, 1, 1)`` |
  76. +-----------+----------------------------+
  77. | *Setter* | set_specular_factor(value) |
  78. +-----------+----------------------------+
  79. | *Getter* | get_specular_factor() |
  80. +-----------+----------------------------+
  81. The specular RGB color of the material. The alpha channel is unused.
  82. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  83. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  84. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  85. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  86. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  87. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`