ResourceLoadFlag.generated.cs 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637
  1. using System;
  2. using System.Runtime.CompilerServices;
  3. using System.Runtime.InteropServices;
  4. namespace BansheeEngine
  5. {
  6. /** @addtogroup Resources
  7. * @{
  8. */
  9. /// <summary>Flags that can be used to control resource loading.</summary>
  10. public enum ResourceLoadFlag
  11. {
  12. /// <summary>No flags.</summary>
  13. None = 0,
  14. /// <summary>If enabled all resources referenced by the root resource will be loaded as well.</summary>
  15. LoadDependencies = 1,
  16. /// <summary>
  17. /// If enabled the resource system will keep an internal reference to the resource so it doesn't get destroyed when it
  18. /// goes out of scope. You can call Resources::release() to release the internal reference. Each call to load will create
  19. /// a new internal reference and therefore must be followed by the same number of release calls. If dependencies are
  20. /// being loaded, they will not have internal references created regardless of this parameter.
  21. /// </summary>
  22. KeepInternalRef = 2,
  23. /// <summary>
  24. /// Determines if the loaded resource keeps original data loaded. Sometime resources will process loaded data and discard
  25. /// the original (e.g. uncompressing audio on load). This flag can prevent the resource from discarding the original
  26. /// data. The original data might be required for saving the resource (via Resources::save), but will use up extra
  27. /// memory. Normally you want to keep this enabled if you plan on saving the resource to disk.
  28. /// </summary>
  29. KeepSourceData = 4,
  30. /// <summary>Default set of flags used for resource loading.</summary>
  31. Default = 3
  32. }
  33. /** @} */
  34. }