Enumeration ResourceLoadFlag

Flags that can be used to control resource loading.

Constructors

  • Parameters

    • do_not_: undefined
    • construct_: undefined
    • this_: undefined
    • type_: undefined

    Returns ResourceLoadFlag

Values

Default = 3

Default set of flags used for resource loading.

If the resource is streaming and the load is synchronous, the system will attempt to perform the web request while blocking the executing thread. For most cases, the resource load should be done with DefaultPreview or DefaultStreaming, to avoid blocking the executing thread.

DefaultPreview = 19

Default set of flags used for streaming resource loading for preview data only.

DefaultStreaming = 11

Default set of flags used for streaming resource loading.

KeepInternalRef = 2

If enabled the resource system will keep an internal reference to the resource so it doesn't get destroyed when it goes out of scope. You can call Resources::release() to release the internal reference. Each call to load will create a new internal reference and therefore must be followed by the same number of release calls. If dependencies are being loaded, they will not have internal references created regardless of this parameter.

KeepSourceData = 4

Determines if the loaded resource keeps original data loaded. Sometime resources will process loaded data and discard the original (e.g. uncompressing audio on load). This flag can prevent the resource from discarding the original data. The original data might be required for saving the resource (via Resources::save), but will use up extra memory. Normally you want to keep this enabled if you plan on saving the resource to disk.

LoadDependencies = 1

If enabled all resources referenced by the root resource will be loaded as well.

PreviewStreaming = 16

If the resource supports streaming, only load the preview dependencies. Do not load other dependencies. Keep internal reference.

If set together with Streaming, streaming will take place and the flag becomes useless.

Streaming = 8

If resource supports streaming, only the low quality version of the resource will be loaded initially, and full resource will be streamed in as the data becomes available.

Methods

  • Takes an array of enum values and combines them as a single enum flag value. This assumes that the target enum is a flag enum that can have their values combined using bitwise operators.

    Type Parameters

    Parameters

    Returns EnumValueTyped<T, number>

    The combined enum value.

  • Type Parameters

    • T

    Parameters

    Returns string

    Compatibility

  • Returns string[]

    Compatibility

  • Parameters

    • index: number

    Returns number

    Compatibility

  • Returns number[]

    Compatibility

  • Gets the name for the enumeration value that matches the specified enumValue.

    Type Parameters

    • T

    Parameters

    Returns string

    The enumeration value or undefined if not found.

  • Gets the enumeration names

    Returns string[]

    The enumeration names.

  • Gets the enumeration value at the specified index.

    Type Parameters

    • T = number

    Parameters

    • index: number

      The index.

    Returns EnumValueTyped<T, number>

    The enumeration value or undefined if not found.

  • Determines if the enum value has the flags set.

    Type Parameters

    Parameters

    Returns boolean

  • Determines if the enum bits were changed from previousValue to currentValue.

    Type Parameters

    Parameters

    Returns boolean

  • Iterates the enumeration names

    Returns Generator<string, any, any>

    The enumeration names.

  • Iterates the enumeration values

    Type Parameters

    • T = any

    Returns Generator<EnumValueTyped<T, number>, any, any>

    The enumeration values.

  • Takes a single enum value and splits it into separated flag values set on the value. This assumes that the target enum is a flag enum that can have their values combined using bitwise operators.

    Type Parameters

    Parameters

    • value: number | BrandedType<number, "enum"> | BrandedType<T, "enum">

      The enum value to have it's value split using bitwise-and operator.

    Returns EnumValueTyped<T, number>[]

    An array of each "bit flag" set in the enum.