aboutsummaryrefslogtreecommitdiffstats
path: root/pages/develop/api/efl/gfx/filter/property/filter_program.txt
blob: a623692ee78c8d8d9aac89ca903a6b52264589b9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
~~Title: Efl.Gfx.Filter.filter_program~~
===== Values =====

  * **code** - %%The Lua program source code.%%
  * **name** - %%An optional name for this filter.%%
===== Description =====




{{page>:develop:api-include:efl:gfx:filter:property:filter_program:description&nouser&nolink&nodate}}

==== Getter ====

%%Gets the code of the filter program set on this object. May be %%''null''%%.%%

//Since 1.18//


{{page>:develop:api-include:efl:gfx:filter:property:filter_program:getter_description&nouser&nolink&nodate}}

==== Setter ====

%%Set a graphical filter program on this object.%%

%%Valid for Text and Image objects at the moment.%%

%%The argument passed to this function is a string containing a valid Lua program based on the filters API as described in the "EFL Graphics Filters" reference page.%%

%%Set to %%''null''%% to disable filtering.%%

//Since 1.18//
{{page>:develop:api-include:efl:gfx:filter:property:filter_program:getter_description&nouser&nolink&nodate}}


===== Signature =====

<code>
@property filter_program @pure_virtual {
    get {
        values {
            code: free(string, free);
            name: free(string, free) @optional;
        }
    }
    set {
        values {
            code: free(string, free);
            name: free(string, free) @optional;
        }
    }
}
</code>

===== C signature =====

<code c>
void efl_gfx_filter_program_get(const Eo *obj, const char **code, const char **name);
void efl_gfx_filter_program_set(Eo *obj, const char *code, const char *name);
</code>

===== Implemented by =====

  * **Efl.Gfx.Filter.filter_program**