Manages a Overlay object, which is used to blend external images on top of SketchUp rendering. More...

#include <overlay.h>

Related Functions
(Note that these are not member functions.)
enum	SUOverlayBeginFrameInfoVersion : uint32_t
	Available versions for the SUOverlayCreateInfo::version field. More...

enum	SUOverlayDrawFrameInfoVersion : uint32_t
	Available versions for SUOverlayDrawFrameInfo::version. More...

enum	SUOverlayImageFormat : uint8_t
	Supported image formats. More...

enum	SUOverlayImageOrientation : uint8_t
	Supported image orientations. More...

enum	SUOverlayCreateInfoVersion : uint32_t
	Available versions for the SUOverlayCreateInfo::version field. More...

typedef struct SUBoundingBox3D(*	SUOverlayGetExtentsFuncT )(SUOverlayRef, void *)
	Signature for SUOverlayCreateInfo::get_extents callback. More...

typedef void(*	SUOverlayBeginFrameFuncT )(SUOverlayRef, const struct SUBeginFrameInfo , void )
	Signature for SUOverlayCreateInfo::begin_frame callback. More...

typedef void(*	SUOverlayDrawFrameFuncT )(SUOverlayRef, struct SUOverlayDrawFrameInfo , void )
	Signature for SUOverlayCreateInfo::draw_frame callback. More...

typedef void(*	SUOverlayEndFrameFuncT )(SUOverlayRef, void *)
	Signature for SUOverlayCreateInfo::end_frame callback. More...

typedef void(*	SUOverlayStartFuncT )(SUOverlayRef, void *)
	Signature for SUOverlayCreateInfo::start callback. More...

typedef void(*	SUOverlayStopFuncT )(SUOverlayRef, void *)
	Signature for SUOverlayCreateInfo::stop callback. More...

SU_RESULT	SUModelCreateOverlay (SUModelRef model, const struct SUOverlayCreateInfo info, SUOverlayRef overlay)
	Creates an overlay and adds it to the model. More...

SU_RESULT	SUModelReleaseOverlay (SUModelRef model, SUOverlayRef *overlay)
	Releases the overlay after removing it from the model. More...

#define	SUOVERLAY_BEGIN_FRAME_INFO_VERSION (SUOVERLAY_BEGIN_FRAME_INFO_VERSION_1)
	Current version of the SUBeginFrameInfo struct. More...

#define	SUOVERLAY_DRAW_FRAME_INFO_VERSION (SUOVERLAY_DRAW_FRAME_INFO_VERSION_1)
	Current version of SUOverlayDrawFrameInfo struct. More...

#define	SUOVERLAY_CREATE_INFO_VERSION (SUOVERLAY_CREATE_INFO_VERSION_1)
	Current version of the SUOverlayCreateInfo struct. More...

SU_RESULT	SUOverlayEnable (SUOverlayRef overlay, bool enabled)
	Enables or disables an overlay. More...

Detailed Description

Manages a Overlay object, which is used to blend external images on top of SketchUp rendering.

Friends And Related Function Documentation

SU_RESULT SUModelCreateOverlay	(	SUModelRef	model,
		const struct SUOverlayCreateInfo *	info,
		SUOverlayRef *	overlay
	)

Since: SketchUp 2024, API 12.0

Parameters

[in]	model	The model object
[in]	info	The information needed to create the overlay object
[out]	overlay	The created overlay object

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if model is an invalid object
SU_ERROR_NULL_POINTER_INPUT if info is NULL
SU_ERROR_NULL_POINTER_OUTPUT if overlay is NULL
SU_ERROR_OVERWRITE_VALID if overlay is already a valid object
SU_ERROR_DUPLICATE if the given SUOverlayCreateInfo::id already exists in the model

SU_RESULT SUModelReleaseOverlay	(	SUModelRef	model,
		SUOverlayRef *	overlay
	)

Parameters

[in]	model	The model object
[in,out]	overlay	The overlay object to be released, will be set to NULL on return.

Since: SketchUp 2024, API 12.0

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if model or overlay is an invalid object
SU_ERROR_NULL_POINTER_INPUT if overlay is NULL
SU_ERROR_NO_DATA if overlay could be found in the model

#define SUOVERLAY_BEGIN_FRAME_INFO_VERSION (SUOVERLAY_BEGIN_FRAME_INFO_VERSION_1)

#define SUOVERLAY_CREATE_INFO_VERSION (SUOVERLAY_CREATE_INFO_VERSION_1)

#define SUOVERLAY_DRAW_FRAME_INFO_VERSION (SUOVERLAY_DRAW_FRAME_INFO_VERSION_1)

typedef void(* SUOverlayBeginFrameFuncT)(SUOverlayRef, const struct SUBeginFrameInfo *, void *)

enum SUOverlayBeginFrameInfoVersion : uint32_t

enum SUOverlayCreateInfoVersion : uint32_t

typedef void(* SUOverlayDrawFrameFuncT)(SUOverlayRef, struct SUOverlayDrawFrameInfo *, void *)

enum SUOverlayDrawFrameInfoVersion : uint32_t

SU_RESULT SUOverlayEnable	(	SUOverlayRef	overlay,
		bool	enabled
	)

Parameters

[in]	overlay	The overlay object
[in]	enabled	Whether to enable or disable

Since: SketchUp 2024, API 12.0

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if overlay is an invalid object

typedef void(* SUOverlayEndFrameFuncT)(SUOverlayRef, void *)

typedef struct SUBoundingBox3D(* SUOverlayGetExtentsFuncT)(SUOverlayRef, void *)

enum SUOverlayImageFormat : uint8_t

enum SUOverlayImageOrientation : uint8_t

typedef void(* SUOverlayStartFuncT)(SUOverlayRef, void *)

typedef void(* SUOverlayStopFuncT)(SUOverlayRef, void *)

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

SketchUpAPI/application/overlay.h
SketchUpAPI/application/model.h

Related Functions

Detailed Description

Friends And Related Function Documentation