A user account is required in order to edit this wiki, but we've had to disable public user registrations due to spam.

To request an account, ask an autoconfirmed user on IRC (such as one of these permanent autoconfirmed members).

Difference between revisions of "ImageBitmap Options"

From WHATWG Wiki
Jump to: navigation, search
(Strongly desired options)
(Strongly desired options)
Line 37: Line 37:
 
* boolean premultiplyAlpha, default = true <blockquote><p>If set to false, image sources that are premultiplied by alpha will have their color components divided by alpha and image sources that are not premultiplied will be left untouched.</p><p>If set to true, image sources that are not premultiplied by alpha will have their color components multiplied by alpha and image sources that are premultiplied will be left untouched.</p><p>When premultiplyAlpha is set to false, the division by alpha may result in loss of precision, which must be avoided whenever possible. For example, if the image source is a blob or an image element, the decoded image may already be available in premultipled form. Rather than divide the already decoded data, the user agent must re-decode the image without premultiplying, thus ensuring that the ImageBitmap is delivered with the highest quality data.</p><p>Image sources that do not have an alpha channel are not affected by this option.</p><p>Caution: Canvases are assumed to be premultiplied image sources, which may not always be accurate.</p>
 
* boolean premultiplyAlpha, default = true <blockquote><p>If set to false, image sources that are premultiplied by alpha will have their color components divided by alpha and image sources that are not premultiplied will be left untouched.</p><p>If set to true, image sources that are not premultiplied by alpha will have their color components multiplied by alpha and image sources that are premultiplied will be left untouched.</p><p>When premultiplyAlpha is set to false, the division by alpha may result in loss of precision, which must be avoided whenever possible. For example, if the image source is a blob or an image element, the decoded image may already be available in premultipled form. Rather than divide the already decoded data, the user agent must re-decode the image without premultiplying, thus ensuring that the ImageBitmap is delivered with the highest quality data.</p><p>Image sources that do not have an alpha channel are not affected by this option.</p><p>Caution: Canvases are assumed to be premultiplied image sources, which may not always be accurate.</p>
 
</blockquote>
 
</blockquote>
* DOMString? crossOrigin, default = null <blockquote><p>The crossOrigin option is a <a href="https://html.spec.whatwg.org/multipage/infrastructure.html#cors-settings-attribute">CORS settings attribute</a>. It is consulted when [[ImageBitmap Constructor taking URL|constructing an ImageBitmap from the URL of an image]]. Because ImageBitmaps can only be constructed from same-origin resources, the crossOrigin option is required in order to create an ImageBitmap from a URL of a cross-origin image resource, and further, the server must grant the request.
+
* DOMString? crossOrigin, default = null <blockquote><p>The crossOrigin option is a [[https://html.spec.whatwg.org/multipage/infrastructure.html#cors-settings-attribute CORS settings attribute]]. It is consulted when [[ImageBitmap Constructor taking URL|constructing an ImageBitmap from the URL of an image]]. Because ImageBitmaps can only be constructed from same-origin resources, the crossOrigin option is required in order to create an ImageBitmap from a URL of a cross-origin image resource, and further, the server must grant the request.
 
</blockquote>
 
</blockquote>
  

Revision as of 18:20, 5 November 2014

This page is a Work in Progress


Problem to be solved: Loading and preparing image resources for rendering to 2D canvas contexts and WebGL contexts is often inefficient using existing APIs.

Use Case Description

WebGL applications often use image media for transferring non-image data (illumination maps, vector maps, etc.) For such applications the image data must usually be decoded without colorspace conversions and without alpha premultiplications.

Current Usage and Workarounds

Currently, there are several ways to apply arbitrary transformations on the client side, many of which involve intermediate copies of the image data. Some solutions involve DataURLs, temporary canvases, or direct manipulation of image data arrays, which are inefficient. Preparing the resources asynchronously also presents an additional challenge to the web developer.
WebGL applications can request that colorspace conversions be skipped at texture upload time by specifying pixel storage parameters, but this currently causes a synchronous image decode, because it is not known in advance that the image will need to be decoded in a special way. This latency is a significant problem for applications that upload many images to the GPU, such as Google Maps.
ImageBitmap offers an opportunity to provide exactly the desired image decoding options when the image is fetched, so that when the ImageBitmap is ready, it is in exactly the desired form for upload to the GPU.

Benefits

With the right API support, image resources can be prepared asynchronously and/or in advance to avoid rendering latency issues. Furthermore, the preparation steps could be performed by native code, and in many case they can be integrated directly into the image decoding step without any additional memory consumption and little or no additional computational burden.

Requests for this Feature

Proposed Solutions

ImageBitmap Construction Options

Add an optional options argument to createImageBitmap to specify image treatments to be applied when creating the ImageBitmap object.

Strongly desired options

  • enum imageOrientation, default = 'topLeft'

    'none': Do not change orientation.

    'flipY': Flip image vertically, disregarding image orientation meta data (EXIF or other), if any.

    'topLeft': identify visual orientation from image media meta data and re-order data so top-down, left-to-right processing for display results in correct visual orientation. If the image source is an ImageBitmap, the image data will be flipped vertically if and only if the source was created with bottomLeft orientation. If the image source holds no orientation information, the image orientation is not changed.

    'bottomLeft': identify visual orientation from image media meta data and re-order data so bottom-up, left-to-right processing for display results in correct visual orientation. If the image source is an ImageBitmap, the image data will be flipped vertically if and only if the source was created with topLeft orientation. If the image source holds no orientation information, the image is flipped vertically.

  • boolean colorspaceConversion, default = true

    If set to false, the ImageBitmap must be created by decoding the source image media without performing any colorspace conversions. This means that the image decoding algorithm must ignore color profile meta-data embedded in the image source as well as the display device color profile. colorspaceConversion only applies when creating ImageBitmaps from bitmap media data (i.e. blobs and image elements with non-vector images)

  • boolean premultiplyAlpha, default = true

    If set to false, image sources that are premultiplied by alpha will have their color components divided by alpha and image sources that are not premultiplied will be left untouched.

    If set to true, image sources that are not premultiplied by alpha will have their color components multiplied by alpha and image sources that are premultiplied will be left untouched.

    When premultiplyAlpha is set to false, the division by alpha may result in loss of precision, which must be avoided whenever possible. For example, if the image source is a blob or an image element, the decoded image may already be available in premultipled form. Rather than divide the already decoded data, the user agent must re-decode the image without premultiplying, thus ensuring that the ImageBitmap is delivered with the highest quality data.

    Image sources that do not have an alpha channel are not affected by this option.

    Caution: Canvases are assumed to be premultiplied image sources, which may not always be accurate.

  • DOMString? crossOrigin, default = null

    The crossOrigin option is a [CORS settings attribute]. It is consulted when constructing an ImageBitmap from the URL of an image. Because ImageBitmaps can only be constructed from same-origin resources, the crossOrigin option is required in order to create an ImageBitmap from a URL of a cross-origin image resource, and further, the server must grant the request.

Other potentially useful options

  • resizedWidth, resizedHeight: dimension to which the image should be resized. Could also be expressed using scale factors
  • resizeFilter: filtering method used for scaling the image (pixelated, low quality, high quality, etc.)
  • frameIndex: for creating an image bitmap from multi-frame image media
  • flipX: like flipY but horizontal
  • colorspace: to decode images to a colorspace other than the device colorspace (sRGB, Adobe RGB, YUV, YCbCr, etc.)
  • custom color tranforms: color matrix, 3D Look up tables, per component look up tables, bias, gain, ...

Processing Model

TBD Explanation of the changes introduced by this solution. It explains how the document is processed, and how errors are handled. This should be very clear, including things such as event timing if the solution involves events, how to create graphs representing the data in the case of semantic proposals, etc.

Limitations

TBD Cases not covered by this solution in relation to the problem description; other problems with this solution, if any.

Implementation

TBD Description of how and why browser vendors would take advantage of this feature.

Adoption

  • Easier to develop asychronous image resource loading and preparation
  • Better performance that what can be implemented using current APIs
  • Applications can rely on the browser resource management facilities for caching decoded image data with the desired options baked-in and for evicting pre-decoded resources in low memory conditions to avoid out-of-memory crashes.

See Also

Related is the ImageBitmap Constructor taking URL.