Khronos Public Bugzilla
Bug 153 - <instance_image> documentation is murky
<instance_image> documentation is murky
Status: NEW
Product: COLLADA
Classification: Unclassified
Component: Specification
1.5.0
Macintosh Mac OS
: P3 normal
: Release 1.5.1
Assigned To: Fabrice Robinet
COLLADA Work Group email alias
: collada-fx
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2009-04-20 00:06 PDT by Ellen Finch
Modified: 2014-01-07 10:23 PST (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Ellen Finch 2009-04-20 00:06:58 PDT
<instance_image> documentation needs improvement:

1. The url attribute is described only as "The URI of the image asset." Should this really be "The id of an <image> element"?

2. The details section lists 2 behavior options within the paragraph; these should be bulleted for clarity.

3. the details section says "The behavior of instantiating an image is typically straight-forward, except for images that are not renderable."  ... And then it tells you nothing at all what to do about those difficult cases! Can we have some hints? Or at least why it's not straight-forward?

4. Also says "If the renderable image is marked as “shared”" ... remove quotes from shared and add "using <renderable share="true" />".

5. The example could be more useful if it showed what the url attribute references. Current example is:

<newparam sid="surfaceTex">
  <sampler2D>
     <instance_image url="noise1"/>
  </sampler2D>
</newparam>

Add before it:
  <image id="noise1">
     ...
  </image>

Does this look OK?