Vizard 8 » Command Index » Vizard objects » texture » <texture>.load
8.0

<texture>.load

This will change the image associated with the texture

<texture>.load(  
filename  
face = viz.POSITIVE_X  
flags = 0  
)  
filename
The filename of the new image to load
face = viz.POSITIVE_X
This is an optional argument used only with Cube Mapped or 3D textures.

With Cube Mapped textures it specifies which face of the cube to apply the image to. This can be one of the following values:

viz.POSITIVE_X
viz.NEGATIVE_X
viz.POSITIVE_Y
viz.NEGATIVE_Y
viz.POSITIVE_Z
viz.NEGATIVE_Z

With 3D textures it specifies which depth slot to load the image into.

In both cases, the file must contain the same width, height, and pixel format as the original texture.
flags = 0
Can include any combination of the following load flags:

Load Flag

Description

viz.LOAD_ASYNC

Load the texture asynchronously. See remarks below.

Remarks

Use this to change the image of the texture. If you load a new image onto the texture, then all objects that had this texture applied to will change also.

If the viz.LOAD_ASYNC flag is set, the texture will be loaded asynchronously. In this case, the command will return immediately with True. The status of the async operation can be queried using the <texture>.getAsyncStatus command. When the async operation completes, due to either success or failure, a viz.ASYNC_EVENT will be triggered. The <vizact>.onAsyncLoad or <viztask>.waitAsyncLoad commands can be used to automatically process this event for a specified texture.

Return Value

True/False

Example

tex = viz.addTexture('tree.jpg')
quad = viz.addTexQuad()
quad.texture(tex) # The quad will now display the tree picture
tex.load('flower.jpg') # The quad will now display the flower picture

See also

<texture>.loadBuffer
<texture>.setImageData
<vizact>.onAsyncLoad
<viztask>.waitAsyncLoad
<texture>.getAsyncStatus