My favorites | English | Sign in

o3d.Bitmap Class Reference

Inherits o3d.ParamObject

List of all members.

Detailed Description

Bitmap provides an interface for basic image operations on bitmap, including scale and crop. A Bitmap can be created from RawData via pack.createBitmapsFromRawData(), and also can be transferred to mip of a Texure2D or a specific face of TextureCUBE via methods in Texture.

Public Types

enum Semantic o3d.Bitmap

Public Member Functions

copyParams(sourceParamObject) o3d.ParamObject
o3d.Param  createParam(paramName, paramTypeName) o3d.ParamObject
flipVertically() o3d.Bitmap
generateMips(sourceLevel, numLevels) o3d.Bitmap
o3d.Param  getParam(paramName) o3d.ParamObject
boolean  isAClassName(className) o3d.ObjectBase
boolean  removeParam(param) o3d.ParamObject

Public Properties

string className o3d.ObjectBase
number clientId o3d.ObjectBase
o3d.Texture.Format format o3d.Bitmap
number height o3d.Bitmap
string name o3d.NamedObject
number numMipmaps o3d.Bitmap
!Array.<!o3d.Param> params o3d.ParamObject
o3d.Bitmap.Semantic semantic o3d.Bitmap
number width o3d.Bitmap

Public Types Documentation

enum o3d.Bitmap.Semantic

After loading an array of Bitmaps with pack.createBitmapsFromRawData you can inspect their semantic to see what they were intended for. This is mostly to distinguish between 6 bitmaps that are faces of a cubemap and 6 bitmaps that are slices of a 3d texture.

  • FACE_POSITIVE_X, 1 face of a cubemap
  • FACE_NEGATIVE_X, 1 face of a cubemap
  • FACE_POSITIVE_Y, 1 face of a cubemap
  • FACE_NEGATIVE_Y, 1 face of a cubemap
  • FACE_POSITIVE_Z, 1 face of a cubemap
  • FACE_NEGATIVE_Z, 1 face of a cubemap
  • IMAGE, normal 2d image
  • SLICE, a slice of a 3d texture.

    • Member Function Documentation

    Bitmap.copyParams ( !o3d.ParamObject sourceParamObject ) [inherited from o3d.ParamObject]

    Copies all the params from a the given source_param_object to this param object. Does not replace any currently existing params with the same name.

    Parameters:
    sourceParamObject param object to copy params from.
    o3d.Param Bitmap.createParam ( string paramName
    string paramTypeName ) [inherited from o3d.ParamObject]

    Creates a Param with the given name and type on the ParamObject. Will fail if a param with the same name already exists.

    Parameters:
    paramName The name of the Param to be created.
    paramTypeName The type of Param to create. Valid types are
  • 'o3d.ParamBoolean'
  • 'o3d.ParamBoundingBox'
  • 'o3d.ParamDrawContext'
  • 'o3d.ParamDrawList'
  • 'o3d.ParamEffect'
  • 'o3d.ParamFloat'
  • 'o3d.ParamFloat2'
  • 'o3d.ParamFloat3'
  • 'o3d.ParamFloat4'
  • 'o3d.ParamFunction'
  • 'o3d.ParamInteger'
  • 'o3d.ParamMaterial'
  • 'o3d.ParamMatrix4'
  • 'o3d.ParamParamArray'
  • 'o3d.ParamRenderSurface'
  • 'o3d.ParamRenderDepthStencilSurface'
  • 'o3d.ParamSampler'
  • 'o3d.ParamSkin'
  • 'o3d.ParamSteamBank'
  • 'o3d.ParamState'
  • 'o3d.ParamString'
  • 'o3d.ParamTexture'
  • 'o3d.ParamTransform'
  • 'o3d.ProjectionParamMatrix4'
  • 'o3d.ProjectionInverseParamMatrix4'
  • 'o3d.ProjectionTransposeParamMatrix4'
  • 'o3d.ProjectionInverseTransposeParamMatrix4'
  • 'o3d.ViewParamMatrix4'
  • 'o3d.ViewInverseParamMatrix4'
  • 'o3d.ViewTransposeParamMatrix4'
  • 'o3d.ViewInverseTransposeParamMatrix4'
  • 'o3d.ViewProjectionParamMatrix4'
  • 'o3d.ViewProjectionInverseParamMatrix4'
  • 'o3d.ViewProjectionTransposeParamMatrix4'
  • 'o3d.ViewProjectionInverseTransposeParamMatrix4'
  • 'o3d.WorldParamMatrix4'
  • 'o3d.WorldInverseParamMatrix4'
  • 'o3d.WorldTransposeParamMatrix4'
  • 'o3d.WorldInverseTransposeParamMatrix4'
  • 'o3d.WorldViewParamMatrix4'
  • 'o3d.WorldViewInverseParamMatrix4'
  • 'o3d.WorldViewTransposeParamMatrix4'
  • 'o3d.WorldViewInverseTransposeParamMatrix4'
  • 'o3d.WorldViewProjectionParamMatrix4'
  • 'o3d.WorldViewProjectionInverseParamMatrix4'
  • 'o3d.WorldViewProjectionTransposeParamMatrix4'
  • 'o3d.WorldViewProjectionInverseTransposeParamMatrix4'
    • Returns:
    o3d.Param.The newly created Param or null on failure.
    Bitmap.flipVertically ( )

    Flips a bitmap vertically in place.

    Bitmap.generateMips ( number sourceLevel
    number numLevels )

    Generates mip maps from the source level to lower levels. You can not currently generate mips for DXT textures although you can load them from dds files.

    Parameters:
    sourceLevel The level to use as the source of the mips.
    numLevels The number of levels to generate below the source level.
    o3d.Param Bitmap.getParam ( string paramName ) [inherited from o3d.ParamObject]

    Searches by name for a Param defined in the object.

    Parameters:
    paramName Name to search for.
    Returns:
    o3d.Param.The Param with the given name, or null otherwise.
    boolean Bitmap.isAClassName ( string className ) [inherited from o3d.ObjectBase]

    Takes the name of a class as an argument, and returns true if this object is either an instance of that class or derives from that class. 

    var t = pack.createObject('o3d.Transform');
t.isAClassName('o3d.Transform');    // true
t.isAClassName('o3d.ParamObject');  // true
t.isAClassName('o3d.Shape');        // false
    Parameters:
    className Name of class to check for.
    Returns:
    boolean.true if this object is a or is derived from the given class name.
    boolean Bitmap.removeParam ( !o3d.Param param ) [inherited from o3d.ParamObject]

    Removes a Param from a ParamObject. This function will fail if the param does not exist on this ParamObject or if the param is unremovable.

    Parameters:
    param param to remove.
    Returns:
    boolean.True if the param was removed.

    Member Property Documentation

    string Bitmap.className [inherited from o3d.ObjectBase]

    The concrete class name for an object derived from ObjectBase. If you want to know if an object is of a certain type you should use objectBase.isAClassName 

    var t = pack.createObject('o3d.Transform');
t.className == 'o3d.Transform';  // true
    This property is read-only.
    number Bitmap.clientId [inherited from o3d.ObjectBase]

    Unique id of the object. This id will be unique, even across multiple O3D clients in the same page. This property is read-only.

    o3d.Texture.Format Bitmap.format

    The format of the bitmap (read only). This property is read-only.

    number Bitmap.height

    The height of the bitmap (read only). This property is read-only.

    string Bitmap.name [inherited from o3d.NamedObject]

    The object's name. Setting this has no meaning to O3D, but is useful for debugging and for the functions Client.getObjects, Pack.getObject, RenderNode.getRenderNodesByNameInTree and RenderNode.getTransformsByNameInTree which search for objects by name.

    number Bitmap.numMipmaps

    Number mip-maps (read only) This property is read-only.

    !Array.<!o3d.Param> Bitmap.params [inherited from o3d.ParamObject]

    Gets all the param on this param object. Each access to this field gets the entire list, so it is best to get it just once. For example: 

    var params = paramObject.params;
for (var i = 0; i < params.length; i++) {
  var param = params[i];
}
    Note that modifications to this array [e.g. push()] will not affect the underlying ParamObject, while modifications to the array's members will affect them. This property is read-only.
    o3d.Bitmap.Semantic Bitmap.semantic

    The Semantic of the bitmap. This property is read-only.

    number Bitmap.width

    The width of the bitmap (read only). This property is read-only.