class_colorarray.rst 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. .. _class_ColorArray:
  2. ColorArray
  3. ==========
  4. **Category:** Built-In Types
  5. Brief Description
  6. -----------------
  7. Array of Colors
  8. Member Functions
  9. ----------------
  10. +--------------------------------------+-----------------------------------------------------------------------------------------------------------+
  11. | void | :ref:`push_back<class_ColorArray_push_back>` **(** :ref:`Color<class_color>` color **)** |
  12. +--------------------------------------+-----------------------------------------------------------------------------------------------------------+
  13. | void | :ref:`resize<class_ColorArray_resize>` **(** :ref:`int<class_int>` idx **)** |
  14. +--------------------------------------+-----------------------------------------------------------------------------------------------------------+
  15. | void | :ref:`set<class_ColorArray_set>` **(** :ref:`int<class_int>` idx, :ref:`Color<class_color>` color **)** |
  16. +--------------------------------------+-----------------------------------------------------------------------------------------------------------+
  17. | :ref:`int<class_int>` | :ref:`size<class_ColorArray_size>` **(** **)** |
  18. +--------------------------------------+-----------------------------------------------------------------------------------------------------------+
  19. | :ref:`ColorArray<class_colorarray>` | :ref:`ColorArray<class_ColorArray_ColorArray>` **(** :ref:`Array<class_array>` from **)** |
  20. +--------------------------------------+-----------------------------------------------------------------------------------------------------------+
  21. Description
  22. -----------
  23. Array of Color, can only contains colors. Optimized for memory usage, can't fragment the memory.
  24. Member Function Description
  25. ---------------------------
  26. .. _class_ColorArray_push_back:
  27. - void **push_back** **(** :ref:`Color<class_color>` color **)**
  28. Append a value to the array.
  29. .. _class_ColorArray_resize:
  30. - void **resize** **(** :ref:`int<class_int>` idx **)**
  31. Resize the array.
  32. .. _class_ColorArray_set:
  33. - void **set** **(** :ref:`int<class_int>` idx, :ref:`Color<class_color>` color **)**
  34. Set an index in the array.
  35. .. _class_ColorArray_size:
  36. - :ref:`int<class_int>` **size** **(** **)**
  37. Return the array size.
  38. .. _class_ColorArray_ColorArray:
  39. - :ref:`ColorArray<class_colorarray>` **ColorArray** **(** :ref:`Array<class_array>` from **)**
  40. Create from a generic array.