formZ SDK | 4.0 Call Back Reference | Surface Style Representation

# fz_srep_flags_enum

Description

Bit encoded flags for a Surface Style Representation. Used by the flags argument of the fz_srep_cbak_info_func callback.

enum fz_srep_flags_enum {

FZ_SREP_FLAG_ALLOW_OPGL_PREVIEW,

FZ_SREP_FLAG_SUPPORT_IMAGE_TEXTURES,

FZ_SREP_FLAG_SUPPORT_PROCEDURAL_TEXTURES,

FZ_SREP_FLAG_SUPPORT_BUMP_MAPPING,

FZ_SREP_FLAG_SUPPORT_TRANSPARENCIES,

FZ_SREP_FLAG_PREVIEW_NO_WINDEX,

FZ_SREP_FLAG_SUPPORT_SOLID_TEXTURES,

FZ_SREP_FLAG_SUPPORT_IMAGE_TEXTURES_EMBD };

Members

FZ_SREP_FLAG_ALLOW_OPGL_PREVIEW

set to TRUE, to add this Surface Style Representation to the Shaded Full options. An entry with the Surface Style Representation's name will be added to the "Use Surface Style Of" menu, and Shaded Full will render this srep as faithful as it can. Note, that the srep needs to also implement at least the fz_srep_cbak_generic_parm callback function. The next three flags allow the srep plugin to further specify how Shaded Full renders the srep.

FZ_SREP_FLAG_SUPPORT_IMAGE_TEXTURES

set to TRUE, if the Surface Style Representation can support image based textures (color, transparency or bump). The images are derived form a file (i.e. stored in a fz_tmap_ptr). Shaded Full will render the textures, as returned by the fz_srep_cbak_generic_parm

FZ_SREP_FLAG_SUPPORT_PROCEDURAL_TEXTURES

set to TRUE, if the Surface Style Representation can support procedural textures (color, transparency or bump). Shaded Full will call the fz_srep_cbak_rndr_texture to create rendered textures for this srep.

FZ_SREP_FLAG_SUPPORT_BUMP_MAPPING

set to TRUE, if the Surface Style Representation can support bump mapping in general. Shaded Full will render bump mapping if set to TRUE

FZ_SREP_FLAG_SUPPORT_TRANSPARENCIES

set to TRUE, if the Surface Style Representation can support transparencies in general. Shaded Full will render transparencies if set to TRUE

FZ_SREP_FLAG_PREVIEW_NO_WINDEX

set to TRUE, if the Surface Style Representation does not need a separate windex ( project) to render the preview in the Surface Style parameters dialog or the preview icon in the palette. This flag affects the callbacks and fz_srep_cbak_data_icon_pview. if set to TRUE, the pview_windex and rmtl arguments to these functions represent a separate project and a separate copy of the surface style and srep to be rendered. If set to FALSE, these arguments represent the original project and original surface style/srep. In other words, if set to FALSE, the srep can rely on the fact that thew preview windex is set up with the proper objects, view ... to render the preview scene. All it has to do is render it. If set to TRUE, it is the srep's responsibily to create a meaningful preview.

FZ_SREP_FLAG_SUPPORT_SOLID_TEXTURES

set to TRUE, if the Surface Style Representation supports solid (3D) textures

FZ_SREP_FLAG_SUPPORT_IMAGE_TEXTURES_EMBD

set to TRUE, if the Surface Style Representation can support image based textures (color, transparency or bump). The images are stored as embedded pixels (i.e. stored in fz_tmap_embd_ptr).

Availability

7.0.0.0

Defined in

fz_srep_api.h