GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SOSFIMAGE (3)

NAME

SoSFImage — Field containing a 2D image

CONTENTS

Inherits From
Synopsis
Description
Methods
See Also

INHERITS FROM

SoField > SoSField > SoSFImage

SYNOPSIS

#include <Inventor/fields/SoSFImage.h>

Methods from class SoSFImage:

    const unsigned char *    
                       
const unsigned char *   getValue(SbVec2s &size, int &nc) const    
void    
                       
void                    setValue(const SbVec2s &size, int nc, const unsigned char *bytes)    
unsigned char *    
                       
unsigned char *         startEditing(SbVec2s &size, int &nc)    
void    
                       
void                    finishEditing()

Methods from class SoSField:

    static SoType    
                    
static SoType        getClassTypeId()

Methods from class SoField:

    void    
                    
void                 setIgnored(SbBool ignore)    
SbBool    
                    
SbBool               isIgnored() const    
SbBool    
                    
SbBool               isDefault() const    
virtual SoType    
                    
virtual SoType       getTypeId() const    
virtual SbBool    
                    
virtual SbBool       isOfType(SoType type) const    
SbBool    
                    
SbBool               set(const char *valueString)    
void    
                    
void                 get(SbString &valueString)    
int    
                    
int                  operator ==(const SoField &f) const    
int    
                    
int                  operator !=(const SoField &f) const    
void    
                    
void                 touch()    
SbBool    
                    
SbBool               connectFrom(SoField *fromField)    
SbBool    
                    
SbBool               connectFrom(SoEngineOutput *fromEngine)    
void    
                    
void                 disconnect()    
SbBool    
                    
SbBool               isConnected() const    
SbBool    
                    
SbBool               isConnectedFromField() const    
SbBool    
                    
SbBool               getConnectedField(SoField *&writingField) const    
SbBool    
                    
SbBool               isConnectedFromEngine() const    
SbBool    
                    
SbBool               getConnectedEngine(SoEngineOutput *&engineOutput) const    
void    
                    
void                 enableConnection(SbBool flag)    
SbBool    
                    
SbBool               isConnectionEnabled() const    
int    
                    
int                  getForwardConnections(SoFieldList &list) const    
SoFieldContainer *    
                    
SoFieldContainer *   getContainer() const

DESCRIPTION

A field containing a two-dimensional image. Images can be greyscale (intensity), greyscale with transparency information, RGB, or RGB with transparency. Each component of the image (intensity, red, green, blue or transparency (alpha)) can have an unsigned one-byte value from 0 to 255.

Values are returned as arrays of unsigned chars. The image is stored in this array starting at the bottom left corner of the image with the intensity or red component of that pixel, followed by either the alpha, the green and blue, or the green, blue and alpha components (depending on the number of components in the image). The next value is the first component of the next pixel to the right.

SoSFImages are written to file as three integers representing the width, height and number of components in the image, followed by width*height hexadecimal values representing the pixels in the image, separated by whitespace. A one-component image will have one-byte hexadecimal values representing the intensity of the image. For example, 0xFF is full intensity, 0x00 is no intensity. A two-component image puts the intensity in the first (high) byte and the transparency in the second (low) byte. Pixels in a three-component image have the red component in the first (high) byte, followed by the green and blue components (so 0xFF0000 is red). Four-component images put the transparency byte after red/green/blue (so 0x0000FF80 is semi-transparent blue). Note: each pixel is actually read as a single unsigned number, so a 3-component pixel with value "0x0000FF" can also be written as "0xFF" or "255" (decimal).

For example,



1 2 1 0xFF 0x00

is a 1 pixel wide by 2 pixel high greyscale image, with the bottom pixel white and the top pixel black. And:


2 4 3 0xFF0000 0xFF00 0 0 0 0 0xFFFFFF 0xFFFF00

is a 2 pixel wide by 4 pixel high RGB image, with the bottom left pixel red, the bottom right pixel green, the two middle rows of pixels black, the top left pixel white, and the top right pixel yellow.

METHODS

    const unsigned char *    
                       
const unsigned char *   getValue(SbVec2s &size, int &nc) const
Returns the pixels in the image as an array of unsigned chars. The size and nc arguments are filled in with the dimensions of the image and the number of components in the image; the number of bytes in the array returned will be size[0]*size[1]*nc.

    void    
                       
void                    setValue(const SbVec2s &size, int nc, const unsigned char *bytes)
Sets the value of this field to be an image of the given size, with the given number of components, and with the given pixel values. size[0]*size[1]*nc bytes from the given array will be copied into internal storage maintained by the SoSFImage field.

    unsigned char *    
                       
unsigned char *         startEditing(SbVec2s &size, int &nc)    
void    
                       
void                    finishEditing()
These methods can be used to efficiently edit the values in an image field. startEditing() returns the size of the image in the size and nc arguments; writing past the end of the array returned is a good way to cause hard-to-find core dumps.

SEE ALSO

SoField, SoSField

Search for    or go to Top of page |  Section 3 |  Main Index


SOSFIMAGE(3IV) (-->)

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.