<multimedia:image>.loadBuffer

Load image into texture from a buffer

 

<multimedia:image>.loadBuffer(
    filename    
    buffer    
    face = viz.POSITIVE_X    

)

 

filename

Filename associated with the buffer. The extension of the filename will tell Vizard what image format the buffer provides (jpg, gif, bmp, etc..).


buffer

Buffer containing the image file data or one of the following buffer flags:

Buffer flags

viz.BUFFER_MMAP

Load buffer through a memory mapped file. This can be used in cluster mode to have the master transfer the file contents to the clients at runtime.


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.


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.

Return Value

True/False

See also

<multimedia:image>.load
<multimedia:image>.setImageData