mirror of
https://github.com/brl/mutter.git
synced 2024-11-26 18:11:05 -05:00
f80cb197a9
This applies an API naming change that's been deliberated over for a
while now which is to rename CoglMaterial to CoglPipeline.
For now the new pipeline API is marked as experimental and public
headers continue to talk about materials not pipelines. The CoglMaterial
API is now maintained in terms of the cogl_pipeline API internally.
Currently this API is targeting Cogl 2.0 so we will have time to
integrate it properly with other upcoming Cogl 2.0 work.
The basic reasons for the rename are:
- That the term "material" implies to many people that they are
constrained to fragment processing; perhaps as some kind of high-level
texture abstraction.
- In Clutter they get exposed by ClutterTexture actors which may be
re-inforcing this misconception.
- When comparing how other frameworks use the term material, a material
sometimes describes a multi-pass fragment processing technique which
isn't the case in Cogl.
- In code, "CoglPipeline" will hopefully be a much more self documenting
summary of what these objects represent; a full GPU pipeline
configuration including, for example, vertex processing, fragment
processing and blending.
- When considering the API documentation story, at some point we need a
document introducing developers to how the "GPU pipeline" works so it
should become intuitive that CoglPipeline maps back to that
description of the GPU pipeline.
- This is consistent in terminology and concept to OpenGL 4's new
pipeline object which is a container for program objects.
Note: The cogl-material.[ch] files have been renamed to
cogl-material-compat.[ch] because otherwise git doesn't seem to treat
the change as a moving the old cogl-material.c->cogl-pipeline.c and so
we loose all our git-blame history.
99 lines
3.5 KiB
C
99 lines
3.5 KiB
C
/*
|
||
* Cogl
|
||
*
|
||
* An object oriented GL/GLES Abstraction/Utility Layer
|
||
*
|
||
* Copyright (C) 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/>.
|
||
*
|
||
* Authors:
|
||
* Neil Roberts <neil@linux.intel.com>
|
||
*/
|
||
|
||
#ifndef __COGL_TEXTURE_3D_PRIVATE_H
|
||
#define __COGL_TEXTURE_3D_PRIVATE_H
|
||
|
||
#include "cogl-handle.h"
|
||
#include "cogl-pipeline-private.h"
|
||
#include "cogl-texture-private.h"
|
||
|
||
#define COGL_TEXTURE_3D(tex) ((CoglTexture3D *) tex)
|
||
|
||
typedef struct _CoglTexture3D CoglTexture3D;
|
||
|
||
struct _CoglTexture3D
|
||
{
|
||
CoglTexture _parent;
|
||
|
||
/* The internal format of the GL texture represented as a
|
||
CoglPixelFormat */
|
||
CoglPixelFormat format;
|
||
/* The internal format of the GL texture represented as a GL enum */
|
||
GLenum gl_format;
|
||
/* The texture object number */
|
||
GLuint gl_texture;
|
||
int width;
|
||
int height;
|
||
int depth;
|
||
GLenum min_filter;
|
||
GLenum mag_filter;
|
||
GLint wrap_mode_s;
|
||
GLint wrap_mode_t;
|
||
GLint wrap_mode_p;
|
||
gboolean auto_mipmap;
|
||
gboolean mipmaps_dirty;
|
||
|
||
CoglTexturePixel first_pixel;
|
||
};
|
||
|
||
GQuark
|
||
_cogl_handle_texture_3d_get_type (void);
|
||
|
||
/*
|
||
* cogl_texture_3d_new_from_bitmap:
|
||
* @bmp_handle: A #CoglHandle to a bitmap.
|
||
* @height: height of the texture in pixels.
|
||
* @depth: depth of the texture in pixels.
|
||
* @flags: Optional flags for the texture, or %COGL_TEXTURE_NONE
|
||
* @internal_format: the #CoglPixelFormat that will be used for storing
|
||
* the buffer on the GPU. If COGL_PIXEL_FORMAT_ANY is given then a
|
||
* premultiplied format similar to the format of the source data will
|
||
* be used. The default blending equations of Cogl expect premultiplied
|
||
* color data; the main use of passing a non-premultiplied format here
|
||
* is if you have non-premultiplied source data and are going to adjust
|
||
* the blend mode (see cogl_pipeline_set_blend()) or use the data for
|
||
* something other than straight blending.
|
||
* @error: A GError return location.
|
||
*
|
||
* Creates a new 3D texture and initializes it with the images in
|
||
* @bmp_handle. The images are assumed to be packed together after one
|
||
* another in the increasing y axis. The height of individual image is
|
||
* given as @height and the number of images is given in @depth. The
|
||
* actual height of the bitmap can be larger than @height × @depth. In
|
||
* this case it assumes there is padding between the images.
|
||
*
|
||
* Return value: the newly created texture or %COGL_INVALID_HANDLE if
|
||
* there was an error.
|
||
*/
|
||
CoglHandle
|
||
_cogl_texture_3d_new_from_bitmap (CoglBitmap *bmp,
|
||
unsigned int height,
|
||
unsigned int depth,
|
||
CoglTextureFlags flags,
|
||
CoglPixelFormat internal_format,
|
||
GError **error);
|
||
|
||
#endif /* __COGL_TEXTURE_3D_PRIVATE_H */
|