Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

vtkExtensionsTypes.h File Reference

#include "vtkExtensionsConfigure.h"
#include <stddef.h>
#include <sys/types.h>
#include <limits.h>

Include dependency graph for vtkExtensionsTypes.h:

Include dependency graph

This graph shows which files directly or indirectly include this file:

Included by dependency graph

Go to the source code of this file.

Classes

struct  vtkInt64Type
 The int64 types are known to be 64 bits each. More...

struct  vtkMaterial
struct  vtkPackedMaterial

Color data types.

typedef vtkUint32Type vtkColorWord
 A color is a 32 bit unsigned integer with four components: R, G, B, and A.

typedef vtkUint8Type vtkColorByte
 The four components (channels) are 8 bit unsigned untegers.

typedef vtkColorWord vtkPackedColor
 A color is a 32 bit unsigned integer with four components: R, G, B, and A.


vtkExtensionsTypes

Defines portable exact integral types.

vtkExtensionsTypes the definitions of portable exact integral type as well as other related types, constants, and macros.

Author:
Sean McInerney
Version:
Revision
1.4
Date:
Date
2004/08/10 07:37:21


VTK_EXTENSIONS_BEGIN_EXTERN_C
typedef unsigned short 		vtkXMLChType
 Define our version of the XML character.


Defines

#define VTK_EXTENSIONS_TEST_BIT(_map, _bit)   ((_map)[(_bit)>>VTK_EXTENSIONS_BITS_PER_LONG_LOG2] & (1L << ((_bit) & (VTK_EXTENSIONS_BITS_PER_LONG-1))))
#define VTK_EXTENSIONS_SET_BIT(_map, _bit)   ((_map)[(_bit)>>VTK_EXTENSIONS_BITS_PER_LONG_LOG2] |= (1L << ((_bit) & (VTK_EXTENSIONS_BITS_PER_LONG-1))))
#define VTK_EXTENSIONS_CLEAR_BIT(_map, _bit)   ((_map)[(_bit)>>VTK_EXTENSIONS_BITS_PER_LONG_LOG2] &= ~(1L << ((_bit) & (VTK_EXTENSIONS_BITS_PER_LONG-1))))
#define VTK_EXTENSIONS_CEILING_LOG2(_log2, _n)
 Compute the log of the least power of 2 greater than or equal to _n.

#define VTK_EXTENSIONS_FLOOR_LOG2(_log2, _n)
 Compute the log of the greatest power of 2 less than or equal to _n.

#define VTK_EXTENSIONS_RGB_MAX   VTK_EXTENSIONS_UINT8_MAX
 Brightest value for R,G,B chars.

#define VTK_EXTENSIONS_MAKE_RGBA(_r, _g, _b, _a)   ((vtkColorWord)(((_r) << 24) | ((_g) << 16) | ((_b) << 8) | (_a)))
 Make an RGBA vtkColorWord.

#define VTK_EXTENSIONS_MAKE_RGB(_r, _g, _b)   VTK_EXTENSIONS_MAKE_RGBA((_r), (_g), (_b), VTK_EXTENSIONS_RGB_MAX)
 Make an RGB vtkColorWord.

#define VTK_EXTENSIONS_MAKE_ABGR(_a, _b, _g, _r)   ((vtkColorWord)(((_a) << 24) | ((_b) << 16) | ((_g) << 8) | (_r)))
 Make an ABGR vtkColorWord.

#define VTK_EXTENSIONS_MAKE_BGR(_b, _g, _r)   VTK_EXTENSIONS_MAKE_ABGR(VTK_EXTENSIONS_RGB_MAX, (_b), (_g), (_r))
 Make a BGR vtkColorWord.

#define VTK_EXTENSIONS_RGBONLY(_rgba)   ((_rgba) & 0xffffff00)
 Get value of vtkColorWord's RGB component exclusive of alpha component.

#define VTK_EXTENSIONS_BGRONLY(_abgr)   ((_abgr) & 0x00ffffff)
 Get value of vtkColorWord's BGR component exclusive of alpha component.

#define VTK_EXTENSIONS_GET_COLORBYTE(_word, _n)   ((vtkColorByte)(((_word) >> ((3-(_n))<<3)) & 0xff))
#define VTK_EXTENSIONS_COLORBYTE_REF(_word, _n)   (((vtkColorByte *)(&(_word)))[(_n)])
 reference a byte within an RGBA vtkColorWord.

#define VTK_EXTENSIONS_COLORBYTE_PTR(_word, _n)   (&(VTK_EXTENSIONS_COLORBYTE_REF((_word), (_n))))
 get a pointer to a vtkColorByte within an RGBA vtkColorWord.

#define VTK_EXTENSIONS_CLAMP_COLORBYTE(_c)

Typedefs

typedef vtkUint8Type vtkPackedBoolType
 Use vtkPackedBoolType within structs.

typedef int vtkstd_bool
 Define a "vtkstd_bool" type.

typedef vtkUint32Type vtkResultType
 Generic result data type.

typedef unsigned long vtkBitmapType
 A vtkBitmapType is a long integer that can be used for bitmaps.


Enumerations

enum  vtkStatusType { VTK_EXTENSIONS_FAILURE = -1, VTK_EXTENSIONS_SUCCESS = 0 }
 Used by routines that have single point of failure or special status return. More...

Define Documentation

#define VTK_EXTENSIONS_BGRONLY (  _abgr   )     ((_abgr) & 0x00ffffff)
 

Get value of vtkColorWord's BGR component exclusive of alpha component.

Definition at line 452 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_BIT (  _n   )     ((vtkUint32Type)1 << (_n))
 

Bit masking macros (n must be <= 31 to be portable).

Note:
_n must be <= 31 to be portable.

Definition at line 317 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_BIT (  _n   )     ((vtkUint32Type)1 << (_n))
 

Bit masking macros (n must be <= 31 to be portable).

Note:
_n must be <= 31 to be portable.

Definition at line 317 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_BITMASK (  _n   )     (VTK_EXTENSIONS_BIT(_n) - 1)
 

Bit masking macros (n must be <= 31 to be portable).

Note:
_n must be <= 31 to be portable.

Definition at line 318 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_BITMASK (  _n   )     (VTK_EXTENSIONS_BIT(_n) - 1)
 

Bit masking macros (n must be <= 31 to be portable).

Note:
_n must be <= 31 to be portable.

Definition at line 318 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_CEILING_LOG2 (  _log2,
_n   ) 
 

Value:

VTK_EXTENSIONS_BEGIN_MACRO                      \
          vtkUint32Type j_ = (vtkUint32Type)(_n);       \
          (_log2) = 0;                                  \
          if ((j_) & ((j_)-1))                          \
            (_log2) += 1;                               \
          if ((j_) >> 16)                               \
            (_log2) += 16, (j_) >>= 16;                 \
          if ((j_) >> 8)                                \
            (_log2) += 8, (j_) >>= 8;                   \
          if ((j_) >> 4)                                \
            (_log2) += 4, (j_) >>= 4;                   \
          if ((j_) >> 2)                                \
            (_log2) += 2, (j_) >>= 2;                   \
          if ((j_) >> 1)                                \
            (_log2) += 1;                               \
        VTK_EXTENSIONS_END_MACRO
Compute the log of the least power of 2 greater than or equal to _n.

The result is returned in _log2.

Definition at line 334 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_CLAMP_COLORBYTE (  _c   ) 
 

Value:

( (_c) <= 0.0 ? 0 :                                                   \
    ( (_c) > (vtkRealType)(VTK_EXTENSIONS_RGB_MAX) ?                    \
      VTK_EXTENSIONS_RGB_MAX : (vtkColorByte)(_c) ) )

Definition at line 466 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_CLEAR_BIT (  _map,
_bit   )     ((_map)[(_bit)>>VTK_EXTENSIONS_BITS_PER_LONG_LOG2] &= ~(1L << ((_bit) & (VTK_EXTENSIONS_BITS_PER_LONG-1))))
 

Definition at line 327 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_COLORBYTE_PTR (  _word,
_n   )     (&(VTK_EXTENSIONS_COLORBYTE_REF((_word), (_n))))
 

get a pointer to a vtkColorByte within an RGBA vtkColorWord.

Definition at line 463 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_COLORBYTE_REF (  _word,
_n   )     (((vtkColorByte *)(&(_word)))[(_n)])
 

reference a byte within an RGBA vtkColorWord.

Definition at line 459 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_ENSURE_ARG (  _a   )     VTK_EXTENSIONS_ENSURE_TRUE(_a, VTK_ERROR)
 

Macros for checking state and args upon entering interface boundaries.

Definition at line 494 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_ENSURE_ARG_MAX (  _a,
_max   )     VTK_EXTENSIONS_ENSURE_TRUE((_a) <= _max, VTK_ERROR)
 

Macros for checking state and args upon entering interface boundaries.

Definition at line 503 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_ENSURE_ARG_MIN (  _a,
_min   )     VTK_EXTENSIONS_ENSURE_TRUE((_a) >= _min, VTK_ERROR)
 

Macros for checking state and args upon entering interface boundaries.

Definition at line 500 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_ENSURE_ARG_POINTER (  _a   )     VTK_EXTENSIONS_ENSURE_TRUE(_a, VTK_ERROR)
 

Macros for checking state and args upon entering interface boundaries.

Definition at line 497 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_ENSURE_ARG_RANGE (  _a,
_min,
_max   )     VTK_EXTENSIONS_ENSURE_TRUE(((_a) >= _min) && ((_a) <= _max), VTK_ERROR)
 

Macros for checking state and args upon entering interface boundaries.

Definition at line 506 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_ENSURE_FALSE (  _x,
_ret   )     VTK_EXTENSIONS_ENSURE_TRUE(!(_x), _ret)
 

Macros for checking the trueness of an expression passed in within an interface implementation.

These need to be compiled regardless of the VTK_EXTENSIONS_BUILD_DEBUG flag.

Definition at line 487 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_ENSURE_STATE (  _state   )     VTK_EXTENSIONS_ENSURE_TRUE(_state, VTK_ERROR)
 

Macros for checking state and args upon entering interface boundaries.

Definition at line 509 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_ENSURE_TRUE (  _x,
_ret   ) 
 

Value:

VTK_EXTENSIONS_BEGIN_MACRO                                      \
          if (!(_x)) {                                                  \
            vtkGenericWarningMacro("ENSURE_TRUE(" #_x ") failed");      \
            return _ret;                                                \
          }                                                             \
        VTK_EXTENSIONS_END_MACRO
Macros for checking the trueness of an expression passed in within an interface implementation.

These need to be compiled regardless of the VTK_EXTENSIONS_BUILD_DEBUG flag.

Definition at line 479 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_FLOOR_LOG2 (  _log2,
_n   ) 
 

Value:

VTK_EXTENSIONS_BEGIN_MACRO                      \
          vtkUint32Type j_ = (vtkUint32Type)(_n);       \
          (_log2) = 0;                                  \
          if ((j_) >> 16)                               \
            (_log2) += 16, (j_) >>= 16;                 \
          if ((j_) >> 8)                                \
            (_log2) += 8, (j_) >>= 8;                   \
          if ((j_) >> 4)                                \
            (_log2) += 4, (j_) >>= 4;                   \
          if ((j_) >> 2)                                \
            (_log2) += 2, (j_) >>= 2;                   \
          if ((j_) >> 1)                                \
            (_log2) += 1;                               \
        VTK_EXTENSIONS_END_MACRO
Compute the log of the greatest power of 2 less than or equal to _n.

The result is returned in _log2.

Note:
This is equivalent to finding the highest set bit in the word.

Definition at line 358 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_GET_ABGR_A (  _abgr   )     ((vtkColorByte)(((_abgr) >> 24) & 0xff))
 

Get one byte value from an ABGR vtkColorWord.

Definition at line 443 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_GET_ABGR_B (  _abgr   )     ((vtkColorByte)(((_abgr) >> 16) & 0xff))
 

Get one byte value from an ABGR vtkColorWord.

Definition at line 441 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_GET_ABGR_G (  _abgr   )     ((vtkColorByte)(((_abgr) >> 8) & 0xff))
 

Get one byte value from an ABGR vtkColorWord.

Definition at line 439 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_GET_ABGR_R (  _abgr   )     ((vtkColorByte)((_abgr) & 0xff))
 

Get one byte value from an ABGR vtkColorWord.

Definition at line 437 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_GET_COLORBYTE (  _word,
_n   )     ((vtkColorByte)(((_word) >> ((3-(_n))<<3)) & 0xff))
 

Definition at line 455 of file vtkExtensionsTypes.h.

Referenced by vtkAbstractPaletteMaterial::ConvertColor(), and vtkPalette::InsertColor().

#define VTK_EXTENSIONS_GET_RGBA_A (  _rgba   )     ((vtkColorByte)((_rgba) & 0xff))
 

Get one byte value from an RGBA vtkColorWord.

Definition at line 431 of file vtkExtensionsTypes.h.

Referenced by vtkPaletteElement::ConvertColor().

#define VTK_EXTENSIONS_GET_RGBA_B (  _rgba   )     ((vtkColorByte)(((_rgba) >> 8) & 0xff))
 

Get one byte value from an RGBA vtkColorWord.

Definition at line 429 of file vtkExtensionsTypes.h.

Referenced by vtkPaletteElement::ConvertColor().

#define VTK_EXTENSIONS_GET_RGBA_G (  _rgba   )     ((vtkColorByte)(((_rgba) >> 16) & 0xff))
 

Get one byte value from an RGBA vtkColorWord.

Definition at line 427 of file vtkExtensionsTypes.h.

Referenced by vtkPaletteElement::ConvertColor().

#define VTK_EXTENSIONS_GET_RGBA_R (  _rgba   )     ((vtkColorByte)(((_rgba) >> 24) & 0xff))
 

Get one byte value from an RGBA vtkColorWord.

Definition at line 425 of file vtkExtensionsTypes.h.

Referenced by vtkPaletteElement::ConvertColor().

#define VTK_EXTENSIONS_INT16_MAX   32767
 

The maximum and minimum values of a vtkInt16Type or vtkUint16Type.

Definition at line 128 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_INT16_MIN   (-32768)
 

The maximum and minimum values of a vtkInt16Type or vtkUint16Type.

Definition at line 129 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_INT32_MAX   VTK_EXTENSIONS_INT32(2147483647)
 

The maximum and minimum values of a vtkInt32Type or vtkUint32Type.

Definition at line 152 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_INT32_MIN   (-VTK_EXTENSIONS_INT32_MAX - 1)
 

The maximum and minimum values of a vtkInt32Type or vtkUint32Type.

Definition at line 153 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_INT32_TO_PTR (  _x   )     ((void *)((char *)0 + (_x)))
 

Use these macros to do 64bit safe pointer conversions.

Definition at line 377 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_INT8_MAX   127
 

The maximum and minimum values of a vtkInt8Type or vtkUint8Type.

Definition at line 111 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_INT8_MIN   (-128)
 

The maximum and minimum values of a vtkInt8Type or vtkUint8Type.

Definition at line 112 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_MAKE_ABGR (  _a,
_b,
_g,
_r   )     ((vtkColorWord)(((_a) << 24) | ((_b) << 16) | ((_g) << 8) | (_r)))
 

Make an ABGR vtkColorWord.

Definition at line 417 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_MAKE_BGR (  _b,
_g,
_r   )     VTK_EXTENSIONS_MAKE_ABGR(VTK_EXTENSIONS_RGB_MAX, (_b), (_g), (_r))
 

Make a BGR vtkColorWord.

Definition at line 420 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_MAKE_RGB (  _r,
_g,
_b   )     VTK_EXTENSIONS_MAKE_RGBA((_r), (_g), (_b), VTK_EXTENSIONS_RGB_MAX)
 

Make an RGB vtkColorWord.

Definition at line 413 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_MAKE_RGBA (  _r,
_g,
_b,
_a   )     ((vtkColorWord)(((_r) << 24) | ((_g) << 16) | ((_b) << 8) | (_a)))
 

Make an RGBA vtkColorWord.

Definition at line 410 of file vtkExtensionsTypes.h.

Referenced by vtkPaletteElement::ConvertColor(), and vtkPaletteElement::ConvertMaterial().

#define VTK_EXTENSIONS_PTR_TO_INT32 (  _x   )     ((char *)(_x) - (char *)0)
 

Use these macros to do 64bit safe pointer conversions.

Definition at line 376 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_RGB_MAX   VTK_EXTENSIONS_UINT8_MAX
 

Brightest value for R,G,B chars.

Definition at line 407 of file vtkExtensionsTypes.h.

Referenced by vtkPaletteElement::ConvertColor(), vtkPaletteElement::ConvertMaterial(), and vtkPalette::InsertColor().

#define VTK_EXTENSIONS_RGBONLY (  _rgba   )     ((_rgba) & 0xffffff00)
 

Get value of vtkColorWord's RGB component exclusive of alpha component.

Definition at line 448 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_SET_BIT (  _map,
_bit   )     ((_map)[(_bit)>>VTK_EXTENSIONS_BITS_PER_LONG_LOG2] |= (1L << ((_bit) & (VTK_EXTENSIONS_BITS_PER_LONG-1))))
 

Definition at line 325 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_SIZE_MAX   ULONG_MAX
 

Definition at line 79 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_SSIZE_MAX   LONG_MAX
 

Definition at line 80 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_TEST_BIT (  _map,
_bit   )     ((_map)[(_bit)>>VTK_EXTENSIONS_BITS_PER_LONG_LOG2] & (1L << ((_bit) & (VTK_EXTENSIONS_BITS_PER_LONG-1))))
 

Definition at line 323 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_UINT16_MAX   65535U
 

The maximum and minimum values of a vtkInt16Type or vtkUint16Type.

Definition at line 130 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_UINT32_MAX   VTK_EXTENSIONS_UINT32(4294967295)
 

The maximum and minimum values of a vtkInt32Type or vtkUint32Type.

Definition at line 154 of file vtkExtensionsTypes.h.

#define VTK_EXTENSIONS_UINT8_MAX   255U
 

The maximum and minimum values of a vtkInt8Type or vtkUint8Type.

Definition at line 113 of file vtkExtensionsTypes.h.

Referenced by vtkAbstractPaletteMaterial::ConvertColor(), and vtkPalette::InsertColor().

#define VTK_FALSE   0
 

Definition at line 254 of file vtkExtensionsTypes.h.

Referenced by vtkStringOps::CanReadDirectory(), vtkStringOps::CanReadFile(), vtkStringOps::CanWriteDirectory(), vtkStringOps::CanWriteFile(), vtkStringOps::CheckDirectoryExists(), vtkStringOps::CheckFileExists(), vtkStringOps::CreateDirectory(), vtkStringOps::Duplicate(), vtkStringOps::Equals(), vtkStringOps::EqualsI(), vtkPaletteElement::Erase(), vtkStringOps::FileJoin(), vtkPalette::FindColor(), vtkUUID::Structure::GetBinary(), vtkStringOps::GetCWD(), vtkStringOps::GetRelativeDirPrefix(), vtkStringOps::Hash(), vtkStringOps::HashN(), vtkPaletteElement::Insert(), vtkAbstractSequence::Insert(), vtkStringOps::IsAbsoluteURI(), vtkStringOps::IsAllWhiteSpace(), vtkStringOps::IsBaseChar(), vtkStringOps::IsChar(), vtkStringOps::IsCombiningChar(), vtkStringOps::IsDigit(), vtkStringOps::IsEmpty(), vtkStringOps::IsExtender(), vtkStringOps::IsHexDigit(), vtkStringOps::IsIdeographic(), vtkStringOps::IsLatin1(), vtkPalette::IsLeaf(), vtkStringOps::IsLower(), vtkStringOps::IsMemberOf(), vtkStringOps::IsNameChar(), vtkStringOps::IsNCNameChar(), vtkUUID::Structure::IsNull(), vtkStringOps::IsNull(), vtkAbstractSequence::IsPresent(), vtkStringOps::IsPubidChar(), vtkPaletteElement::IsRoot(), vtkPalette::IsRoot(), vtkTraversal::IsSelfOrAncestor(), vtkStringOps::IsSpace(), vtkStringOps::IsUpper(), vtkStringOps::IsWhiteSpace(), vtkStringOps::ParseBoolean(), vtkAbstractSequence::PushBack(), vtkStringOps::Release(), vtkStringOps::ResolveURIReference(), vtkStringOps::TextToBin(), vtkStringOps::Tokenize(), vtkStringOps::Trim(), and vtkStringOps::ValidateRegion().

#define VTK_TRUE   1
 

Definition at line 253 of file vtkExtensionsTypes.h.

Referenced by vtkStringOps::CanReadDirectory(), vtkStringOps::CanReadFile(), vtkStringOps::CanWriteDirectory(), vtkStringOps::CanWriteFile(), vtkStringOps::CheckDirectoryExists(), vtkStringOps::CheckFileExists(), vtkStringOps::Equals(), vtkStringOps::EqualsI(), vtkStringOps::FileJoin(), vtkPalette::FindColor(), vtkUUID::Structure::GetBinary(), vtkAbstractSequence::Insert(), vtkStringOps::IsAllWhiteSpace(), vtkStringOps::IsBaseChar(), vtkStringOps::IsChar(), vtkStringOps::IsCombiningChar(), vtkStringOps::IsDigit(), vtkStringOps::IsEmpty(), vtkPaletteElement::IsEmpty(), vtkStringOps::IsExtender(), vtkStringOps::IsHexDigit(), vtkStringOps::IsIdeographic(), vtkStringOps::IsLatin1(), vtkPaletteElement::IsLeaf(), vtkStringOps::IsLower(), vtkStringOps::IsMemberOf(), vtkStringOps::IsNameChar(), vtkStringOps::IsNCNameChar(), vtkUUID::Structure::IsNull(), vtkStringOps::IsNull(), vtkAbstractSequence::IsPresent(), vtkStringOps::IsPubidChar(), vtkPalette::IsRoot(), vtkTraversal::IsSelfOrAncestor(), vtkStringOps::IsSpace(), vtkStringOps::IsUpper(), vtkStringOps::IsWhiteSpace(), vtkStringOps::ParseBoolean(), vtkAbstractSequence::PushBack(), vtkStringOps::TextToBin(), and vtkStringOps::ValidateRegion().

Typedef Documentation

typedef unsigned long vtkBitmapType
 

A vtkBitmapType is a long integer that can be used for bitmaps.

Definition at line 321 of file vtkExtensionsTypes.h.

typedef vtkIntnType vtkBoolType
 

Use vtkBoolType for variables and parameter types.

Use VTK_FALSE and VTK_TRUE for clarity of target type in assignments and actual arguments. Use 'if (bool)', 'while (!bool)', '(bool) ? x : y', etc. to test booleans just as you would C int-valued conditions.

Definition at line 251 of file vtkExtensionsTypes.h.

Referenced by vtkStringOps::CanWriteFile(), vtkStringOps::CreateDirectory(), vtkStringOps::FileJoin(), vtkStringOps::IsAbsoluteURI(), vtkTraversal::IsEqual(), and vtkTraversal::IsSame().

typedef vtkInt8Type vtkChar
 

Some general typedefs that are defined for internal flexibility.

Note that vtkUTF16ChType is fixed at 16 bits, whereas vtkXMLChType floats in size per platform, to whatever is the native wide char format there. vtkUCS4ChType is fixed at 32 bits. The types we defined them in terms of are defined per compiler, using whatever types are the right ones for them to get these 16/32 bit sizes.

The following definitions are compiler-specific. The C standard does not guarantee that wchar_t has at least 16 bits, so wchar_t is no less portable than unsigned short! All should be unsigned values to avoid sign extension during bit mask & shift operations.

Definition at line 305 of file vtkExtensionsTypes.h.

typedef vtkUint8Type vtkColorByte
 

The four components (channels) are 8 bit unsigned untegers.

Definition at line 385 of file vtkExtensionsTypes.h.

typedef vtkUint32Type vtkColorWord
 

A color is a 32 bit unsigned integer with four components: R, G, B, and A.

Definition at line 383 of file vtkExtensionsTypes.h.

Referenced by vtkPaletteElement::ConvertColor(), and vtkPalette::FindColor().

typedef vtkXMLChType vtkDOMChar
 

Some general typedefs that are defined for internal flexibility.

Note that vtkUTF16ChType is fixed at 16 bits, whereas vtkXMLChType floats in size per platform, to whatever is the native wide char format there. vtkUCS4ChType is fixed at 32 bits. The types we defined them in terms of are defined per compiler, using whatever types are the right ones for them to get these 16/32 bit sizes.

The following definitions are compiler-specific. The C standard does not guarantee that wchar_t has at least 16 bits, so wchar_t is no less portable than unsigned short! All should be unsigned values to avoid sign extension during bit mask & shift operations.

Definition at line 308 of file vtkExtensionsTypes.h.

typedef vtkInt32Type vtkOffset32Type
 

A type for representing byte offsets from some location.

Definition at line 231 of file vtkExtensionsTypes.h.

typedef vtkInt64Type vtkOffset64Type
 

A type for representing byte offsets from some location.

Definition at line 232 of file vtkExtensionsTypes.h.

typedef vtkUint8Type vtkPackedBoolType
 

Use vtkPackedBoolType within structs.

Use where bitfields are not desireable but minimum and consistant overhead matters.

Definition at line 262 of file vtkExtensionsTypes.h.

typedef vtkColorWord vtkPackedColor
 

A color is a 32 bit unsigned integer with four components: R, G, B, and A.

Definition at line 387 of file vtkExtensionsTypes.h.

typedef ptrdiff_t vtkPtrdiffType
 

A type for pointer difference.

Variables of this type are suitable for storing a pointer or pointer sutraction.

Definition at line 240 of file vtkExtensionsTypes.h.

typedef vtkUint32Type vtkResultType
 

Generic result data type.

Definition at line 287 of file vtkExtensionsTypes.h.

typedef unsigned long vtkSizeType
 

vtkSizeType is the unsigned integral type.

Definition at line 77 of file vtkExtensionsTypes.h.

Referenced by vtkStringOps::Concatenate(), vtkStringOps::Copy(), vtkStringOps::Duplicate(), vtkStringOps::Equals(), vtkStringOps::EqualsI(), vtkStringOps::FileJoin(), vtkStringOps::FileRootname(), vtkStringOps::FindSubString(), vtkStringOps::GetCWD(), vtkStringOps::GetRelativeDirPrefix(), vtkStringOps::IndexNotOf(), vtkStringOps::IndexOf(), vtkStringOps::IsAllWhiteSpace(), vtkStringOps::IsSuffix(), vtkStringOps::Length(), vtkStringOps::ParseBoolean(), vtkStringOps::ParseDoubleVec(), vtkStringOps::ParseFloatVec(), vtkStringOps::ParseIntVec(), vtkStringOps::ParseUintVec(), and vtkStringOps::Trim().

typedef long vtkSSizeType
 

Definition at line 78 of file vtkExtensionsTypes.h.

Referenced by vtkStringOps::GetRelativePrefix(), vtkStringOps::HashN(), vtkStringOps::LastIndexNotOf(), and vtkStringOps::LastIndexOf().

typedef int vtkstd_bool
 

Define a "vtkstd_bool" type.

This should be used as the return type of comparison operators to keep STL happy on all platforms. It should not be used elsewhere.

Definition at line 272 of file vtkExtensionsTypes.h.

typedef vtkUint16Type vtkUCS2ChType
 

Some general typedefs that are defined for internal flexibility.

Note that vtkUTF16ChType is fixed at 16 bits, whereas vtkXMLChType floats in size per platform, to whatever is the native wide char format there. vtkUCS4ChType is fixed at 32 bits. The types we defined them in terms of are defined per compiler, using whatever types are the right ones for them to get these 16/32 bit sizes.

The following definitions are compiler-specific. The C standard does not guarantee that wchar_t has at least 16 bits, so wchar_t is no less portable than unsigned short! All should be unsigned values to avoid sign extension during bit mask & shift operations.

Definition at line 309 of file vtkExtensionsTypes.h.

typedef vtkUint32Type vtkUCS4ChType
 

Some general typedefs that are defined for internal flexibility.

Note that vtkUTF16ChType is fixed at 16 bits, whereas vtkXMLChType floats in size per platform, to whatever is the native wide char format there. vtkUCS4ChType is fixed at 32 bits. The types we defined them in terms of are defined per compiler, using whatever types are the right ones for them to get these 16/32 bit sizes.

The following definitions are compiler-specific. The C standard does not guarantee that wchar_t has at least 16 bits, so wchar_t is no less portable than unsigned short! All should be unsigned values to avoid sign extension during bit mask & shift operations.

Definition at line 311 of file vtkExtensionsTypes.h.

typedef vtkInt64Type vtkUint64Type
 

Definition at line 192 of file vtkExtensionsTypes.h.

typedef unsigned long vtkUptrdiffType
 

A type for pointer difference.

Variables of this type are suitable for storing a pointer or pointer sutraction.

Definition at line 241 of file vtkExtensionsTypes.h.

typedef vtkUint16Type vtkUTF16ChType
 

Some general typedefs that are defined for internal flexibility.

Note that vtkUTF16ChType is fixed at 16 bits, whereas vtkXMLChType floats in size per platform, to whatever is the native wide char format there. vtkUCS4ChType is fixed at 32 bits. The types we defined them in terms of are defined per compiler, using whatever types are the right ones for them to get these 16/32 bit sizes.

The following definitions are compiler-specific. The C standard does not guarantee that wchar_t has at least 16 bits, so wchar_t is no less portable than unsigned short! All should be unsigned values to avoid sign extension during bit mask & shift operations.

Definition at line 307 of file vtkExtensionsTypes.h.

Referenced by vtkStringOps::ToUTF16::data(), vtkStringOps::ToLatin1::ToLatin1(), and vtkStringOps::ToUTF8::ToUTF8().

typedef vtkUint32Type vtkUTF32ChType
 

Some general typedefs that are defined for internal flexibility.

Note that vtkUTF16ChType is fixed at 16 bits, whereas vtkXMLChType floats in size per platform, to whatever is the native wide char format there. vtkUCS4ChType is fixed at 32 bits. The types we defined them in terms of are defined per compiler, using whatever types are the right ones for them to get these 16/32 bit sizes.

The following definitions are compiler-specific. The C standard does not guarantee that wchar_t has at least 16 bits, so wchar_t is no less portable than unsigned short! All should be unsigned values to avoid sign extension during bit mask & shift operations.

Definition at line 310 of file vtkExtensionsTypes.h.

typedef vtkUint8Type vtkUTF8ChType
 

Some general typedefs that are defined for internal flexibility.

Note that vtkUTF16ChType is fixed at 16 bits, whereas vtkXMLChType floats in size per platform, to whatever is the native wide char format there. vtkUCS4ChType is fixed at 32 bits. The types we defined them in terms of are defined per compiler, using whatever types are the right ones for them to get these 16/32 bit sizes.

The following definitions are compiler-specific. The C standard does not guarantee that wchar_t has at least 16 bits, so wchar_t is no less portable than unsigned short! All should be unsigned values to avoid sign extension during bit mask & shift operations.

Definition at line 306 of file vtkExtensionsTypes.h.

Referenced by vtkStringOps::ToUTF8::data(), vtkStringOps::ToLatin1::ToLatin1(), and vtkStringOps::ToUTF16::ToUTF16().

Enumeration Type Documentation

enum vtkStatusType
 

Used by routines that have single point of failure or special status return.

Enumeration values:
VTK_EXTENSIONS_FAILURE 
VTK_EXTENSIONS_SUCCESS 

Definition at line 278 of file vtkExtensionsTypes.h.

Variable Documentation

VTK_EXTENSIONS_BEGIN_EXTERN_C typedef unsigned short vtkXMLChType
 

Define our version of the XML character.

Definition at line 65 of file vtkExtensionsTypes.h.

Generated on Tue Aug 10 03:39:52 2004 for vtkExtensions by doxygen 1.3.7