screen_start_effect()

Start the effect on the specified window.

Synopsis:

#include <screen/screen.h>
 
int screen_start_effect(screen_window_t win, float duration, int notify)

Arguments:

win

The handle of the window whose effect property is to be started.

duration

The duration that the effect will be in place.

notify

A flag to indicate whether or not a SCREEN_EVENT_EFFECT_COMPLETE event is to be sent upon completion of screen_start_effect(). 1 indicates that a SCREEN_EVENT_EFFECT_COMPLETE is to be sent and 0 indicates that no event is sent upon completion of screen_start_effect().

Library:

libscreen

Description:

Function Type: Delayed Execution

This function starts the effect on a window for a specified duration.

Returns:

0 if the value(s) of the property was set to new value(s), or -1 if an error occurred (errno is set).