SketchUp C API
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Related Functions
SURenderingOptionsRef Struct Reference

Used to get and set values in a rendering options object. More...

#include <SketchUpAPI/model/rendering_options.h>

Related Functions

(Note that these are not member functions.)

enum SUResult SURenderingOptionsGetNumKeys (SURenderingOptionsRef rendering_options, size_t *count)
 Gets the number of available rendering options keys. More...
 
enum SUResult SURenderingOptionsGetKeys (SURenderingOptionsRef rendering_options, size_t len, SUStringRef keys[], size_t *count)
 Retrieves keys associated with the rendering options object. More...
 
enum SUResult SURenderingOptionsSetValue (SURenderingOptionsRef rendering_options, const char *key, SUTypedValueRef value_in)
 Sets values in a rendering options object. More...
 
enum SUResult SURenderingOptionsGetValue (SURenderingOptionsRef rendering_options, const char *key, SUTypedValueRef *value_out)
 Retrieves the value of a given rendering option. More...
 

Detailed Description

Used to get and set values in a rendering options object.

Friends And Related Function Documentation

enum SUResult SURenderingOptionsGetKeys ( SURenderingOptionsRef  rendering_options,
size_t  len,
SUStringRef  keys[],
size_t *  count 
)
related

Retrieves keys associated with the rendering options object.

Since
SketchUp 2017, API 5.0
Parameters
[in]rendering_optionsThe rendering options object.
[in]lenThe number of keys to retrieve.
[out]keysThe keys retrieved.
[out]countThe number of keys retrieved.
Returns
enum SUResult SURenderingOptionsGetNumKeys ( SURenderingOptionsRef  rendering_options,
size_t *  count 
)
related

Gets the number of available rendering options keys.

Since
SketchUp 2017, API 5.0
Parameters
[in]rendering_optionsThe rendering options object.
[out]countThe number of keys available.
Returns
enum SUResult SURenderingOptionsGetValue ( SURenderingOptionsRef  rendering_options,
const char *  key,
SUTypedValueRef value_out 
)
related

Retrieves the value of a given rendering option.

Parameters
[in]rendering_optionsThe rendering options object.
[in]keyThe key. Assumed to be UTF-8 encoded.
[out]value_outThe value retrieved.
Returns

The breakdown of rendering options and value types is shown in the table below.

Rendering Option Value Type
BackgroundColor SUTypedValueType_Color
BandColor SUTypedValueType_Color
ConstructionColor SUTypedValueType_Color
DepthQueWidth SUTypedValueType_Int32
DisplayColorByLayer SUTypedValueType_Bool
DisplayDims SUTypedValueType_Bool
DisplayFog SUTypedValueType_Bool
DisplayInstanceAxes SUTypedValueType_Bool
DisplaySectionPlanes (since SketchUp 2014, API 2.0) SUTypedValueType_Bool
DisplaySectionCuts (since SketchUp 2015, API 3.0) SUTypedValueType_Bool
DisplaySketchAxes SUTypedValueType_Bool
DisplayText SUTypedValueType_Bool
DisplayWatermarks SUTypedValueType_Bool
DrawBackEdges (since SketchUp 2015, API 3.0) SUTypedValueType_Bool
DrawDepthQue SUTypedValueType_Bool
DrawGround SUTypedValueType_Bool
DrawHidden SUTypedValueType_Bool
DrawHiddenGeometry (since SketchUp 2020, API 8.0) SUTypedValueType_Bool
DrawHiddenObjects (since SketchUp 2020, API 8.0) SUTypedValueType_Bool
DrawHorizon SUTypedValueType_Bool
DrawLineEnds SUTypedValueType_Bool
DrawProfilesOnly SUTypedValueType_Bool
DrawSilhouettes SUTypedValueType_Bool
DrawUnderground SUTypedValueType_Bool
EdgeColorMode SUTypedValueType_Int32
EdgeDisplayMode SUTypedValueType_Int32
EdgeType SUTypedValueType_Int32
ExtendLines SUTypedValueType_Bool
FaceBackColor SUTypedValueType_Color
FaceFrontColor SUTypedValueType_Color
FogColor SUTypedValueType_Color
FogEndDist SUTypedValueType_Double
FogStartDist SUTypedValueType_Double
FogUseBkColor SUTypedValueType_Bool
ForegroundColor SUTypedValueType_Color
GroundColor SUTypedValueType_Color
GroundTransparency SUTypedValueType_Int32
HideConstructionGeometry SUTypedValueType_Bool
HighlightColor SUTypedValueType_Color
HorizonColor SUTypedValueType_Color
InactiveFade SUTypedValueType_Double
InactiveHidden SUTypedValueType_Bool
InstanceFade SUTypedValueType_Double
InstanceHidden SUTypedValueType_Bool
JitterEdges SUTypedValueType_Bool
LineEndWidth SUTypedValueType_Int32
LineExtension SUTypedValueType_Int32
LockedColor SUTypedValueType_Color
MaterialTransparency SUTypedValueType_Bool
ModelTransparency SUTypedValueType_Bool
RenderMode SUTypedValueType_Int32
SectionActiveColor SUTypedValueType_Color
SectionCutDrawEdges (since SketchUp 2015, API 3.0) SUTypedValueType_Bool
SectionCutFilled (since SketchUp 2018, API 6.0) SUTypedValueType_Bool
SectionCutWidth SUTypedValueType_Int32
SectionDefaultCutColor SUTypedValueType_Color
SectionDefaultFillColor (since SketchUp 2018, API 6.0) SUTypedValueType_Color
SectionInactiveColor SUTypedValueType_Color
ShowViewName SUTypedValueType_Bool
SilhouetteWidth SUTypedValueType_Int32
SkyColor SUTypedValueType_Color
Texture SUTypedValueType_Bool
TransparencySort SUTypedValueType_Int32

Some of the options map to enumerated values, as shown in the table below.

Option Value Meaning
EdgeColorMode 0: ObjectColor
  1: ForegroundColor
  2: DirectionColor
EdgeDisplayMode 0: EdgeDisplayNone
  1: EdgeDisplayAll
  2: EdgeDisplayStandalone
RenderMode 0: RenderWireframe
  1: RenderHidden
  2: RenderFlat
  3: RenderSmooth
  4: RenderTextureObsolete
  5: RenderNoMaterials
EdgeType 0: EdgeStandard
  1: EdgeNPR
Note
The rendering option FaceColorMode was removed in SketchUp 2019.1.
enum SUResult SURenderingOptionsSetValue ( SURenderingOptionsRef  rendering_options,
const char *  key,
SUTypedValueRef  value_in 
)
related

Sets values in a rendering options object.

Parameters
[in]rendering_optionsThe rendering options object.
[in]keyThe key. Assumed to be UTF-8 encoded.
[in]value_inThe value used to set the option.
Returns

The documentation for this struct was generated from the following files: