LayerShaderLayer Class Reference Library » Layer Shader

#include <lib_layershader.h>

详细描述

Represents a layer in a LayerShader .

公共成员函数

LayerShaderLayer GetNext ()
LayerType   GetType ()
String   GetName ( BaseDocument *doc)
BaseBitmap GetPreview ()
Bool   GetParameter ( Int32 id, GeData &d) const
Bool   SetParameter ( Int32 id, const GeData &d)

私有成员函数

  LayerShaderLayer ()
  ~LayerShaderLayer ()

构造函数 & 析构函数文档编制

◆  LayerShaderLayer()

LayerShaderLayer () private

◆  ~LayerShaderLayer()

~ LayerShaderLayer () private

成员函数文档编制

◆  GetNext()

LayerShaderLayer * GetNext ( )

Gets the next layer.

注意
Use this to navigate trough the layers of a layer shader.
返回
The next layer. The layer shader owns the pointed layer.

◆  GetType()

LayerType GetType ( )

Gets the layer type.

返回
The layer type: LayerType

◆  GetName()

String GetName ( BaseDocument doc )

Retrieves the name of the layer.

参数
[in] doc The document for the operation. The caller owns the pointed documented.
返回
The layer name.

◆  GetPreview()

BaseBitmap * GetPreview ( )

Retrieves the preview bitmap.

返回
The preview bitmap. The layer shader owns the pointed bitmap.

◆  GetParameter()

Bool GetParameter ( Int32   id ,
GeData d  
) const

Retrieves layer parameters.

参数
[in] id The ID of the parameter to get:
For all layers: LAYER_S_PARAM_ALL
For folders ( TypeFolder ): LAYER_S_PARAM_FOLDER
For shaders ( TypeShader ): LAYER_S_PARAM_SHADER
For brightness/contrast layers ( TypeBrightnessContrast ): LAYER_S_PARAM_BC
For HSL layers ( TypeHSL ): LAYER_S_PARAM_HSL
For posterize layers ( TypePosterize ): LAYER_S_PARAM_POSTER
For colorize layers ( TypeColorize ): LAYER_S_PARAM_COLORIZE
For clamp layers ( TypeClamp ): LAYER_S_PARAM_CLAMP
For clip layers ( TypeClip ): LAYER_S_PARAM_CLIP
For distorter layers ( TypeDistorter ): LAYER_S_PARAM_DISTORT
For transform layers ( TypeTransform ): LAYER_S_PARAM_TRANS
.
[out] d Filled with the parameter value.
返回
true if the parameter could be retrieved, otherwise false .

◆  SetParameter()

Bool SetParameter ( Int32   id ,
const GeData d  
)

Sets layer parameters.

参数
[in] id The ID of the parameter to set:
For all layers: LAYER_S_PARAM_ALL
For folders ( TypeFolder ): LAYER_S_PARAM_FOLDER
For shaders ( TypeShader ): LAYER_S_PARAM_SHADER
For brightness/contrast layers ( TypeBrightnessContrast ): LAYER_S_PARAM_BC
For HSL layers ( TypeHSL ): LAYER_S_PARAM_HSL
For posterize layers ( TypePosterize ): LAYER_S_PARAM_POSTER
For colorize layers ( TypeColorize ): LAYER_S_PARAM_COLORIZE
For clamp layers ( TypeClamp ): LAYER_S_PARAM_CLAMP
For clip layers ( TypeClip ): LAYER_S_PARAM_CLIP
For distorter layers ( TypeDistorter ): LAYER_S_PARAM_DISTORT
For transform layers ( TypeTransform ): LAYER_S_PARAM_TRANS
.
[in] d The new parameter value.
返回
true if the parameter could be set, otherwise false .