Logo Search packages:      
Sourcecode: blender version File versions

IMB_imbuf_types.h File Reference


Detailed Description

Contains defines and structs used throughout the imbuf module.

IMB_imbuf_types.h (mar-2001 nzc)

Types needed for using the image buffer.

Imbuf is external code, slightly adapted to live in the Blender context. It requires an external jpeg module, and the avi-module (also external code) in order to function correctly.

This file contains types and some constants that go with them. Most are self-explanatory (e.g. IS_amiga tests whether the buffer contains an Amiga-format file).

Id
IMB_imbuf_types.h,v 1.11 2003/12/04 18:18:04 sirdude Exp

***** BEGIN GPL/BL DUAL LICENSE BLOCK *****

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. The Blender Foundation also sells licenses for use in proprietary software under the Blender License. See http://www.blender.org/BL/ for information about this.

This program 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 General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

The Original Code is Copyright (C) 2001-2002 by NaN Holding BV. All rights reserved.

The Original Code is: all of this file.

Contributor(s): none yet.

***** END GPL/BL DUAL LICENSE BLOCK *****

Todo:
Clean up includes.

Definition in file IMB_imbuf_types.h.

#include <stdio.h>
#include "DNA_listBase.h"

Go to the source code of this file.

Classes

struct  ImBuf
 The basic imbuf type

This is the abstraction of an image. ImBuf is the basic type used for all imbuf operations. More...


Defines

imbuf_formats Image file formats
These defines are bit flags for the various image file formats.

#define AM_ham   (0x0800 | AMI)
#define AM_hbrite   (0x0080 | AMI)
#define AMI   (1 << 31)
 Identifier for an image file format.
#define AN_c233   (Anim | C233)
#define AN_hamx   (Anim | HAMX)
#define AN_tanx   (Anim | TANX)
#define AN_yuvx   (Anim | YUVX)
#define Anim   (1 << 29)
#define BMP   (1 << 26)
#define C233   1
#define HAMX   3
#define JPG   (1 << 27)
#define JPG_JST   (JPG | (2 << 8))
#define JPG_MAX   (JPG | (3 << 8))
#define JPG_MSK   (0xffffff00)
#define JPG_STD   (JPG | (0 << 8))
#define JPG_VID   (JPG | (1 << 8))
#define PNG   (1 << 30)
#define RAWTGA   (TGA | 1)
#define TANX   4
#define TGA   (1 << 28)
#define YUVX   2
Imbuf Component flags
These flags determine the components of an ImBuf struct.

#define IB_cmap   (1 << 2)
#define IB_fields   (1 << 11)
#define IB_freem   (1 << 6)
#define IB_mem   (1 << 14)
#define IB_planes   (1 << 1)
#define IB_rect   (1 << 0)
 Flag defining the components of the ImBuf struct.
#define IB_subdlta   (1 << 9)
#define IB_test   (1 << 7)
#define IB_ttob   (1 << 8)
#define IB_vert   (1 << 4)
#define IB_zbuf   (1 << 13)
Imbuf File Type Tests
These macros test if an ImBuf struct is the corresponding file type.

#define IMAGIC   0732
#define IS_amiga(x)   (x->ftype & AMI)
 Tests the ImBuf.ftype variable for the file format.
#define IS_anim(x)   (x->ftype & Anim)
#define IS_bmp(x)   (x->ftype & BMP)
#define IS_ham(x)   ((x->ftype & AM_ham) == AM_ham)
#define IS_hamx(x)   (x->ftype == AN_hamx)
#define IS_hbrite(x)   ((x->ftype & AM_hbrite) == AM_hbrite)
#define IS_iris(x)   (x->ftype == IMAGIC)
#define IS_jpg(x)   (x->ftype & JPG)
#define IS_jstjpg(x)   ((x->ftype & JPG_MSK) == JPG_JST)
#define IS_maxjpg(x)   ((x->ftype & JPG_MSK) == JPG_MAX)
#define IS_png(x)   (x->ftype & PNG)
#define IS_stdjpg(x)   ((x->ftype & JPG_MSK) == JPG_STD)
#define IS_tga(x)   (x->ftype & TGA)
#define IS_vidjpg(x)   ((x->ftype & JPG_MSK) == JPG_VID)

Enumerations

enum  ImBuf_userflagsMask { IB_BITMAPFONT = 1 << 0, IB_BITMAPDIRTY = 1 << 1 }
 Flags for the user?


Generated by  Doxygen 1.6.0   Back to index