Unigine.WidgetSpriteNode Class
| Inherits: | WidgetSprite |
This class is used to display separate nodes together with all their children. This widget supports alpha channel masking. But unlike WidgetSpriteViewport, it does not support engine postprocesses (like HDR, DOF, motion blur, glow, etc.); only postprocess materials can be applied to it.
WidgetSpriteNode Class
Properties
Node Node#
The current node set for displaying.
set
Sets a node to be displayed.
set value -
Node.
float IFps#
The current frame duration used to render widgetspritenode viewport.
set
Sets a constant frame duration used to render WidgetSpriteNode viewport. For example, it can be used to decrease the frame rate to get higher performance.
set value -
Frame duration in seconds (1/FPS). If a too small value is provided, 1E-6 will be used instead.
int LightUsage#
The type of lighting for the widgetspritenode.
set
Sets the type of the lighting for the WidgetSpriteNode.
set value -
The lighting type. Can be one of the following:
int SkipFlags#
The skip flag set for the current viewport.
set
Sets the skip flag for the WidgetSpriteViewport viewport.
set value -
A skip flag. Available flags:
- SKIP_SHADOWS
- SKIP_VISUALIZER
- SKIP_POSTEFFECTS
- SKIP_DYNAMIC_REFLECTIONS
- SKIP_VELOCITY_BUFFER
- SKIP_SRGB
string EnvironmentTextureName#
The name of the environment texture.
set
Sets the given name for Environment texture.
set value -
Texture name to be set.
string PostMaterials#
Names of the current post postprocess materials that are applied after all other postprocess are rendered. they are used after engine.render.getpostmaterials(), if any.
set
Sets post postprocess materials that are applied after all other postprocess are rendered. They are used after engine.render.setPostMaterials(), if any.
set value -
Comma-separated names of postprocess materials.
mat4 Modelview#
The current model-view matrix.
set
Sets a model-view matrix.
set value -
Model-view matrix.
mat4 Projection#
The current projection matrix.
set
Sets a projection matrix.
set value -
Projection matrix.
int ReflectionViewportMask#
The current bit mask for rendering reflections into the viewport. reflections are rendered in the sprite viewport if masks of reflective materials match this one (one bit at least).
set
Sets a bit mask for rendering reflections into the viewport. Reflections are rendered in the sprite viewport if masks of reflective materials match this one (one bit at least).
set value -
Integer, each bit of which is a mask.
int ViewportMask#
The current bit mask for rendering into the viewport. node is rendered in the sprite viewport if its mask matches this one.
set
Sets a bit mask for rendering into the viewport. Node is rendered in the sprite viewport if its mask matches this one.
set value -
Integer, each bit of which is a mask.
int TextureHeight#
The height of the texture buffer used for a widget that affects the widget size.
set
Sets the height of the texture buffer used for a widget. This affects the widget size accordingly.
set value -
Height of the texture buffer size.
int TextureWidth#
The width of the texture buffer used for a widget that affects the widget size.
set
Sets the width of the texture buffer used for a widget. This affects the widget size accordingly.
set value -
Width of the texture buffer size.
int AspectCorrection#
The value indicating if the aspect correction enabled for widgetspritenode.
set
Sets the aspect correction for the WidgetSpriteNode. 1 enables correction, 0 disables.
set value -
1 to enable aspect correction, 0 to disable.
Members
static WidgetSpriteNode ( Gui gui, int width, int height ) #
Constructor. Creates a new sprite with given properties and adds it to the specified GUI.Arguments
- Gui gui - GUI, to which the new sprite will belong.
- int width - Width of the sprite.
- int height - Height of the sprite.
static WidgetSpriteNode ( int width, int height ) #
Constructor. Creates a new sprite with given properties and adds it to the Engine GUI.Arguments
- int width - Width of the sprite.
- int height - Height of the sprite.
void SetCamera ( Camera camera ) #
Copies parameters of the given Camera instance.Arguments
- Camera camera - Camera to be copied.
Camera GetCamera ( ) #
Copies the instance of camera.Return value
Camera instance.void AppendSkipFlags ( int flags ) #
Appends a new skip flag without rewriting already set.Arguments
- int flags - A skip flag. Available flags:
- SKIP_SHADOWS
- SKIP_VISUALIZER
- SKIP_POSTEFFECTS
- SKIP_DYNAMIC_REFLECTIONS
- SKIP_VELOCITY_BUFFER
- SKIP_SRGB
int CheckSkipFlags ( int flags ) #
Checks if given flags are already set.Arguments
- int flags - A skip flag. Available flags:
- SKIP_SHADOWS
- SKIP_VISUALIZER
- SKIP_POSTEFFECTS
- SKIP_DYNAMIC_REFLECTIONS
- SKIP_VELOCITY_BUFFER
- SKIP_SRGB
Return value
1 if flag/flags already set, otherwise 0.void RemoveSkipFlags ( int flags ) #
Removes the given skip flag without affecting other set flags.Arguments
- int flags - A skip flag to be removed. Available flags:
- SKIP_SHADOWS
- SKIP_VISUALIZER
- SKIP_POSTEFFECTS
- SKIP_DYNAMIC_REFLECTIONS
- SKIP_VELOCITY_BUFFER
- SKIP_SRGB
void RenderImage ( Image image ) #
Renders the viewport into an image.Arguments
- Image image - Reference to a target image.
Last update:
2020-07-31
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)