AtlasTexture.xml 1.4 KB

1234567891011121314151617181920212223242526272829303132
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="AtlasTexture" inherits="Texture" category="Core" version="3.1">
  3. <brief_description>
  4. Packs multiple small textures in a single, bigger one. Helps to optimize video memory costs and render calls.
  5. </brief_description>
  6. <description>
  7. [Texture] resource aimed at managing big textures files that pack multiple smaller textures. Consists of a [Texture], a margin that defines the border width,
  8. and a region that defines the actual area of the AtlasTexture.
  9. </description>
  10. <tutorials>
  11. </tutorials>
  12. <demos>
  13. </demos>
  14. <methods>
  15. </methods>
  16. <members>
  17. <member name="atlas" type="Texture" setter="set_atlas" getter="get_atlas">
  18. The texture that contains the atlas. Can be any [Texture] subtype.
  19. </member>
  20. <member name="filter_clip" type="bool" setter="set_filter_clip" getter="has_filter_clip">
  21. If [code]true[/code], clips the area outside of the region to avoid bleeding of the surrounding texture pixels.
  22. </member>
  23. <member name="margin" type="Rect2" setter="set_margin" getter="get_margin">
  24. The margin around the region. The [Rect2]'s 'size' parameter ('w' and 'h' in the editor) resizes the texture so it fits within the margin.
  25. </member>
  26. <member name="region" type="Rect2" setter="set_region" getter="get_region">
  27. The AtlasTexture's used region.
  28. </member>
  29. </members>
  30. <constants>
  31. </constants>
  32. </class>