BitmapTexture : TextureMap

Constructor

bitmaptexture ...

bitmaptex ...

Properties

<Bitmaptexture>.bitmap        Bitmap   default: Bitmap:

The bitmap of the texture map. The script can perform any bitmap operations on this bitmap and the changes will be reflected in the texture map. In order to see the results of changing the bitmap in Material Editor and in the viewports, you need to modify any one bitmapTexture property in the Material Editor user interface.

<Bitmaptexture>.filename      String   default: ""   -- alias: file_name

The name of the bitmap file.

<Bitmaptexture>.filtering     Integer  default: 0

The method of pixel averaging used in antialiasing the bitmap:

0- Pyramidal (Requires less memory and is adequate for most purposes.)

1- Summed Area (Requires much more memory, but yields generally superior results.)

2- None (Turns off filtering.)

<Bitmaptexture>.monoOutput    Integer  default: 0

Some parameters, such as opacity or specular level are a single value as opposed to a material's three-value color components. Controls in this group determine the source of the Output mono channel in terms of the input bitmap:

0- RGB Intensity (Uses the intensity of the red, green, and blue channels for mapping. The color of the pixels is ignored and only the value or luminance of the pixels is used. The colors are computed as gray values in the range between 0 (black) and 255 (white).)

1- Alpha (Uses the intensity of the alpha channel for mapping.)

<Bitmaptexture>.RGBOutput     Integer  default: 0

The RGB Channel Output determines where the output RGB part comes from. The controls in this group affect only maps for material components that display color: Ambient, Diffuse, Specular, Filter Color, Reflection, and Refraction.

0- RGB (Displays the full color values of the pixels.)

1- Alpha as Gray (Displays tones of gray based on the levels of the alpha channel.)

<Bitmaptexture>.apply         Boolean  default: false

Turn on to use the cropping or placements settings.

<Bitmaptexture>.cropPlace     Integer  default: 0

Set whether cropping or placement is active:

0- Crop

1- Place

<Bitmaptexture>.clipu         Float    default: 0.0   -- animatable, alias: clip_u_offset

Adjusts the bitmap location along the U-axis.

<Bitmaptexture>.clipv         Float    default: 0.0   -- animatable, alias: clip_v_offset

Adjusts the bitmap location along the V-axis.

<Bitmaptexture>.clipw         Float    default: 1.0   -- animatable, alias: clip_u_width

Adjusts the width of the bitmap.

<Bitmaptexture>.cliph         Float    default: 1.0   -- animatable, alias: clip_v_width

Adjusts the height of the bitmap.

<Bitmaptexture>.jitter        Float    default: 1.0   -- animatable, alias: jitter_placement

The amount of random offset. At 0, there is no random offset.

<BitmapTex>.useJitter         BooleanClass    default: false   --  boolean

Apply the .jitter value.

<Bitmaptexture>.alphasource   Integer  default: 0

Controls in this group determine the source of the Output alpha channel in terms of the input bitmap:

0- Image Alpha (Uses the image's alpha channel.)

1- RGB Intensity (Converts the colors in the bitmap to grayscale tonal values and uses them for transparency. Black is transparent and white is opaque.)

2- None (Opaque; does not use transparency.)

<Bitmaptexture>.preMultAlpha  Boolean  default: true

Determines how alpha is treated in the bitmap. When turned on, the default, premultiplied alpha is expected in the file. When turned off, the alpha is treated as non-premultiplied, and any RGB values are ignored.

<Bitmaptexture>.starttime    Time default: 0f

The frame where the playback of the animated map will begin.

<Bitmaptexture>.playbackrate  Float    default: 1.0

Lets you speed up and slow down the rate that the animation is applied to the map (for example, 1.0 is normal speed, 2.0 is twice as fast, .333 is 1/3 as fast).

<Bitmaptexture>.endcondition  Integer  default: 0

These controls determine what happens after the last frame of the animation:

0- Loop (Causes the animation to loop over and over again.)

1- Ping Pong (Causes the animation to be played backwards, making every animated sequence "loop smoothly.")

2- Hold (Causes the last frame of the animation to be frozen on the surface until the end of the scene.)

<Bitmaptexture>.coords        StandardUVGen           -- alias: coordinates

See UVGenClass for the StandardUVGen properties.

<Bitmaptexture>.output        StandardTextureOutput

See TexOutputClass for the StandardTextureOutput properties.

Associated Methods

enumerateFiles [ <MAXWrapper_obj> ] <function> [ <arg> ]    \

    [ #inactive ] [ #videoPost ] [ #render ] [ #missing ]   \

[ #localOnly ]

Lets you run through all the bitmap files currently used in the scene or in an individual object. You can filter this so it just gives you the bitmap files that are inactive or missing.

See Bitmap Files for a description of this method's parameters.

freeSceneBitmaps()

Frees up all the memory used by the image file bitmap caches. This is useful if memory is fragmented with a lot of different bitmaps and you want to have just the ones currently active reloaded.

See also