BRender Technical Reference Manual:4 Data Structures (Alphabetical Reference):br_map_find_cbfn
Next|Prev|Up
The Call-Back Function
Specification
CBFnMapFind()

br_map_find_cbfn


The Call-Back Function

This type defines a function, registered with BrMapFindHook()
290, to be called when BrMapFind()289 or BrMapFindMany()290 fail to find any map.

The typedef

(See fwproto.h for a precise declaration)

br_pixelmap* br_map_find_cbfn(const char*) Find (when BrMapFind() fails)

Specification


CBFnMapFind()

Description:
An application defined call-back function used when BrMapFind()
289 or BrMapFindMany()290 fail.

Declaration:
br_pixelmap* BR_CALLBACK CBFnMapFind(const char* name)

Arguments:
const char * name

The search pattern supplied to BrMapFind()289 or BrMapFindMany()290 that did not match any map.

Preconditions:
BRender has completed initialisation. No map has an identifier that successfully matches the search pattern.

Effects:
Application defined.

Result:
br_pixelmap *

Either return an existing map that is deemed appropriate for the search pattern, or Null if there isn't one. This value will be returned by BrMapFind()289 or BrMapFindMany()290.

Remarks:
This could either be used to supply a default map or to create a map. If maps were created on demand, then this function could search another list of available maps (but not yet created) and see if the pattern matched any of them, if it did, one of them could be registered and returned. Note that there is no way to supply more than one map.

See Also:
BrMapFind()289, BrMapFindMany()290, BrMapFindHook()290, BrMapFindFailedLoad()291.



Generated with CERN WebMaker