Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::interop::MaskEffect2DEnums Struct Reference

#include <kanzi/interop/autogen/core.ui/effect/mask_effect2d_enums.hpp>

Public Types

enum  Channel {
  Channel::Alpha, Channel::Red, Channel::Green, Channel::Blue,
  Channel::Luminance
}
 Defines the mask texture channels that you can use as the mask. More...
 
enum  HorizontalAlignment {
  HorizontalAlignment::Left, HorizontalAlignment::Right, HorizontalAlignment::Center, HorizontalAlignment::Stretch,
  HorizontalAlignment::Count
}
 Defines the horizontal alignment modes. More...
 
enum  Stretch {
  Stretch::None, Stretch::Fill, Stretch::Uniform, Stretch::UniformToFill,
  Stretch::Repeat, Stretch::Count
}
 Defines the stretch modes. More...
 
enum  VerticalAlignment {
  VerticalAlignment::Bottom, VerticalAlignment::Top, VerticalAlignment::Center, VerticalAlignment::Stretch,
  VerticalAlignment::Count
}
 Defines the vertical alignment modes. More...
 

Member Enumeration Documentation

Defines the stretch modes.

Enumerator
None 

Does not stretch the mask.

Fill 

Stretches the mask to fill the node.

Uniform 

Stretches the mask using uniform scaling to fill the node in either vertical or horizontal direction, whichever requires smaller scale.

UniformToFill 

Stretches the mask using uniform scaling to fill the node in either vertical or horizontal direction, whichever requires larger scale.

Repeat 

Does not stretch the mask, and allows the mask to repeat outside of its area based on the mask texture wrap mode.

Count 

The number of stretch modes.

Defines the vertical alignment modes.

Enumerator
Bottom 

Aligns the bottom edge of the mask with the bottom edge of the node.

Top 

Aligns the top edge of the mask with the top edge of the node.

Center 

Centers the mask vertically in the node.

Stretch 

Stretches the mask vertically to fit the node from the top edge to the bottom edge.

Count 

The number of vertical alignment modes.

Defines the horizontal alignment modes.

Enumerator
Left 

Aligns the left edge of the mask with the left edge of the node.

Right 

Aligns the right edge of the mask with the right edge of the node.

Center 

Centers the mask horizontally in the node.

Stretch 

Stretches the mask horizontally to fit the node from the left edge to the right edge.

Count 

The number of horizontal alignment modes.

Defines the mask texture channels that you can use as the mask.

Enumerator
Alpha 

Uses the alpha channel as the mask.

Red 

Uses the red color channel as the mask.

Green 

Uses the green color channel as the mask.

Blue 

Uses the blue color channel as the mask.

Luminance 

Uses the luminance calculated from the red, green, and blue color channels as the mask.


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