Functions related to Photorendering.
More...
|
enum | API_RendSetTypeID { APIRendSet_EffectsID
, APIRendSet_ImageID
} |
| The enumeration of the available photorendering tab page types. More...
|
|
Functions related to Photorendering.
◆ API_RendSetTypeID
The enumeration of the available photorendering tab page types.
◆ ACAPI_Rendering_ChangeRenderingSets()
GSErrCode ACAPI_Rendering_ChangeRenderingSets |
( |
void * | rendEffects, |
|
|
API_RendSetTypeID | rendSetType ) |
Changes the photorendering settings.
- Parameters
-
rendEffects | [in] Data of a "PhotoRendering Settings..." tab page. The type depends on the prefsType parameter |
rendSetType | [in] Type of the PhotoRendering Settings you want to modify |
- Returns
- NoError - The function has completed with success.
- APIERR_BADPARS - rendInfo is nullptr or rendSetType is invalid
- Example
GSErrCode err;
if (err == NoError) {
rendEffects.useBkgAlpha = true;
}
if (err == NoError) {
rendImage.bkgSkyRGB.f_red = 0.7;
rendImage.bkgSkyRGB.f_green = 0.5;
rendImage.bkgSkyRGB.f_blue = 1.0;
}
delete rendImage.bkgPictFile;
◆ ACAPI_Rendering_GetRenderingSceneNames()
GSErrCode ACAPI_Rendering_GetRenderingSceneNames |
( |
GS::Array< GS::UniString > * | sceneNames | ) |
|
Returns the names of all the named Rendering Scenes.
- Parameters
-
sceneNames | [out] Array of the names of all the named Rendering Scenes. |
- Returns
- NoError - The function has completed with success.
- APIERR_BADPARS - sceneNames is nullptr.
◆ ACAPI_Rendering_GetRenderingSets()
GSErrCode ACAPI_Rendering_GetRenderingSets |
( |
void * | rendInfo, |
|
|
API_RendSetTypeID | rendSetType, |
|
|
const GS::UniString * | sceneName = nullptr ) |
Returns information on the photorendering settings.
- Parameters
-
rendInfo | [out] Data of a "PhotoRendering Settings..." tab page. The type depends on the prefsType parameter |
rendSetType | [in] Type of the PhotoRendering Settings you want to get |
sceneName | [in] The name of the Rendering Scene of which the settings you want to get. If nullptr, the settings of the current Scene will be returned. |
- Returns
- NoError - The function has completed with success.
- APIERR_BADPARS - rendInfo is nullptr or rendSetType is invalid
- APIERR_BADNAME - The sceneName parameter was not nullptr, and no named Rendering Scene exists with this name.
◆ ACAPI_Rendering_PhotoRender()
Creates a photorealistic image of the 3D window.
- Parameters
-
photoRenderPars | [in] Parameters for saving the photorendered picture into image file |
printPars | [in] Printing options for producing printed output of the photorendered picture. Optional parameter, can be nullptr |
- Returns
- NoError - The function has completed with success.
- APIERR_BADDATABASE - The current database does not match the current window
- APIERR_BADPARS - Either the rendPars parameter is nullptr
- Example
IO::Location fileLoc ("c:\\temp\\MyPicture.jpg");
if (fileLoc.GetStatus () != NoError)
rendPars.fileTypeID = APIFType_JPEGFile;
rendPars.file = &fileLoc;
#if defined (macintosh)
rendPars.colorDepth = APIColorDepth_MiC;
#endif
#if defined (WINDOWS)
rendPars.colorDepth = APIColorDepth_TC24;
#endif
◆ ACAPI_Rendering_SetCurrentRenderingScene()
GSErrCode ACAPI_Rendering_SetCurrentRenderingScene |
( |
const GS::UniString * | newCurrentSceneName | ) |
|
Sets the current Rendering Scene to the given named Rendering Scene.
- Parameters
-
newCurrentSceneName | [in] The name of the Rendering Scene, which you want to set as the current Scene. |
- Returns
- NoError - The function has completed with success.
- APIERR_BADPARS - newCurrentSceneName is nullptr.
- APIERR_BADNAME - No named Rendering Scene exists with this name (newCurrentSceneName).
- APIERR_GENERAL - Could not set newCurrentSceneName as the current Scene.