MultiCam Boards Documentation > MultiCam Documentation > MultiCam Reference > Surface Class > Surface Dynamics Category > Adjust Level (Surface Dynamics) > SurfaceState

SurfaceState

Description

Type

Enumerated

Description

State of the surface

"Set" effect

Sets the specified state to the surface, to be used with caution

"Get" effect

Returns the state of the surface

Classification

Class

Surface

Category

Surface Dynamics

Level

Adjust

Identifiers

String

SurfaceState

C, C++

MC_SurfaceState

.NET

MC.SurfaceState

Numerical

31

This parameter allows to read and write the current state of the surface.

Possible values

Name

Identifier

Description

FREE

MC_SurfaceState_FREE

The surface is ready to accept a grabbed image.

FILLING

MC_SurfaceState_FILLING

The surface is currently receiving a grabbed image.

FILLED

MC_SurfaceState_FILLED

The surface has finished receiving a grabbed image.

PROCESSING

MC_SurfaceState_PROCESSING

The surface is currently processing the image.

RESERVED

MC_SurfaceState_RESERVED

The surface is set aside by the application.

For more information, refer to Surface States.