pixi.js
    Preparing search index...

    Interface CanvasSourceOptionsAdvanced

    Options for creating a CanvasSource.

    interface CanvasSourceOptions {
        _resourceId?: number;
        addressMode?: WRAP_MODE;
        addressModeU?: WRAP_MODE;
        addressModeV?: WRAP_MODE;
        addressModeW?: WRAP_MODE;
        alphaMode?: ALPHA_MODES;
        antialias?: boolean;
        autoDensity?: boolean;
        autoGarbageCollect?: boolean;
        autoGenerateMipmaps?: boolean;
        compare?: COMPARE_FUNCTION;
        destroyed?: boolean;
        dimensions?: TEXTURE_DIMENSIONS;
        format?: TEXTURE_FORMATS;
        height?: number;
        label?: string;
        lodMaxClamp?: number;
        lodMinClamp?: number;
        magFilter?: SCALE_MODE;
        maxAnisotropy?: number;
        minFilter?: SCALE_MODE;
        mipLevelCount?: number;
        mipmapFilter?: SCALE_MODE;
        resolution?: number;
        resource?: ICanvas;
        scaleMode?: SCALE_MODE;
        transparent?: boolean;
        width?: number;
        wrapMode?: WRAP_MODE;
        destroy(): void;
        update(): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    _resourceId? addressMode? addressModeU? addressModeV? addressModeW? alphaMode? antialias? autoDensity? autoGarbageCollect? autoGenerateMipmaps? compare? destroyed? dimensions? format? height? label? lodMaxClamp? lodMinClamp? magFilter? maxAnisotropy? minFilter? mipLevelCount? mipmapFilter? resolution? resource? scaleMode? transparent? width? wrapMode?

    Methods

    destroy? update?

    Properties

    Optional_resourceId

    _resourceId?: number
    addressMode?: WRAP_MODE

    setting this will set wrapModeU,wrapModeV and wrapModeW all at once!

    addressModeU?: WRAP_MODE

    specifies the {{GPUAddressMode|address modes}} for the texture width, height, and depth coordinates, respectively.

    addressModeV?: WRAP_MODE

    specifies the {{GPUAddressMode|address modes}} for the texture width, height, and depth coordinates, respectively.

    addressModeW?: WRAP_MODE

    Specifies the {{GPUAddressMode|address modes}} for the texture width, height, and depth coordinates, respectively.

    alphaMode?: ALPHA_MODES

    the alpha mode of the texture

    antialias?: boolean

    Only really affects RenderTextures. Should we use antialiasing for this texture. It will look better, but may impact performance as a Blit operation will be required to resolve the texture.

    autoDensity?: boolean

    Should the canvas be resized to preserve its screen width and height regardless of the resolution of the renderer, this is only supported for HTMLCanvasElement and will be ignored if the canvas is an OffscreenCanvas.

    autoGarbageCollect?: boolean

    If true, the Garbage Collector will unload this texture if it is not used after a period of time

    autoGenerateMipmaps?: boolean

    Should we auto generate mipmaps for this texture? This will automatically generate mipmaps for this texture when uploading to the GPU. Mipmapped textures take up more memory, but can look better when scaled down.

    For performance reasons, it is recommended to NOT use this with RenderTextures, as they are often updated every frame. If you do, make sure to call updateMipmaps after you update the texture.

    compare?: COMPARE_FUNCTION

    When provided the sampler will be a comparison sampler with the specified COMPARE_FUNCTION. Note: Comparison samplers may use filtering, but the sampling results will be implementation-dependent and may differ from the normal filtering rules.

    destroyed?: boolean = false

    Has the style been destroyed?

    dimensions?: TEXTURE_DIMENSIONS

    how many dimensions does this texture have? currently v8 only supports 2d

    format?: TEXTURE_FORMATS

    the format that the texture data has

    height?: number

    the pixel height of this texture source. This is the REAL pure number, not accounting resolution

    label?: string

    optional label, can be used for debugging

    lodMaxClamp?: number

    Specifies the minimum and maximum levels of detail, respectively, used internally when sampling a texture.

    lodMinClamp?: number

    specifies the minimum and maximum levels of detail, respectively, used internally when sampling a texture.

    magFilter?: SCALE_MODE

    specifies the sampling behavior when the sample footprint is smaller than or equal to one texel.

    maxAnisotropy?: number

    Specifies the maximum anisotropy value clamp used by the sampler. Note: Most implementations support TextureStyle#maxAnisotropy values in range between 1 and 16, inclusive. The used value of TextureStyle#maxAnisotropy will be clamped to the maximum value that the platform supports.

    setting this to anything higher than 1 will set scale modes to 'linear'

    minFilter?: SCALE_MODE

    specifies the sampling behavior when the sample footprint is larger than one texel.

    mipLevelCount?: number

    The number of mip levels to generate for this texture. this is overridden if autoGenerateMipmaps is true

    mipmapFilter?: SCALE_MODE

    specifies behavior for sampling between mipmap levels.

    resolution?: number

    the resolution of the texture.

    resource?: ICanvas

    the resource that will be uploaded to the GPU. This is where we get our pixels from eg an ImageBimt / Canvas / Video etc

    scaleMode?: SCALE_MODE

    setting this will set magFilter,minFilter and mipmapFilter all at once!

    transparent?: boolean

    if true, this canvas will be set up to be transparent where possible

    width?: number

    the pixel width of this texture source. This is the REAL pure number, not accounting resolution

    wrapMode?: WRAP_MODE

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods