mirror of
https://github.com/brl/mutter.git
synced 2024-12-25 20:32:16 +00:00
36575502e8
This updates some of the cogl2-clip-state.h cogl_clip_ API documentation to make it consistent with the documentation for corresponding framebuffer clip stack API in cogl-framebuffer.h Reviewed-by: Neil Roberts <neil@linux.intel.com>
54 lines
1.5 KiB
C
54 lines
1.5 KiB
C
/*
|
|
* Cogl
|
|
*
|
|
* An object oriented GL/GLES Abstraction/Utility Layer
|
|
*
|
|
* Copyright (C) 2007,2008,2009,2010 Intel Corporation.
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
*
|
|
*/
|
|
|
|
#if !defined(__COGL_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
|
|
#error "Only <cogl/cogl.h> can be included directly."
|
|
#endif
|
|
|
|
#ifndef __COGL2_CLIP_STATE_H
|
|
#define __COGL2_CLIP_STATE_H
|
|
|
|
#include <cogl/cogl-types.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
#define cogl_clip_push_from_path cogl2_clip_push_from_path
|
|
/**
|
|
* cogl_clip_push_from_path:
|
|
* @path: The path to clip with.
|
|
*
|
|
* Sets a new clipping area using the silhouette of the specified,
|
|
* filled @path. The clipping area is intersected with the previous
|
|
* clipping area. To restore the previous clipping area, call
|
|
* call cogl_clip_pop().
|
|
*
|
|
* Since: 1.8
|
|
* Stability: Unstable
|
|
*/
|
|
void
|
|
cogl_clip_push_from_path (CoglPath *path);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __COGL2_CLIP_STATE_H */
|