1 #ifndef __DALI_TOOLKIT_OVERLAY_EFFECT_H__
2 #define __DALI_TOOLKIT_OVERLAY_EFFECT_H__
5 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/dali.h>
24 namespace Dali DALI_IMPORT_API
31 * OverlayEffect is used to apply an overlay image to the actor.
32 * Typically overlay images should be the same size as the main image being viewed, but this isn't essential.
36 * ImageActor actor = ImageActor::New( Image( EXAMPLE_IMAGE_PATH ) );
37 * OverlayEffect overlayEffect = OverlayEffect::New( Image::New( OVERLAY_IMAGE_PATH ) );
38 * actor.SetShaderEffect( overlayEffect );
40 class DALI_IMPORT_API OverlayEffect : public ShaderEffect
45 * Create an empty OverlayEffect handle.
52 virtual ~OverlayEffect();
55 * Create a OverlayEffect.
56 * @return A handle to a newly allocated OverlayEffect.
58 static OverlayEffect New( Image overlayImage );
60 private: // Not intended for application developers
62 DALI_INTERNAL OverlayEffect( ShaderEffect handle );
65 } // namespace Toolkit
69 #endif // __DALI_TOOLKIT_OVERLAY_EFFECT_H__