InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IPixMapImageStreamData Class Referenceabstract

#include <IPixMapImageStreamData.h>

Inheritance diagram for IPixMapImageStreamData:
IPMUnknown

Public Types

enum  { kTransparentSampleValue = 0xFE }
 

Public Member Functions

virtual void SetPixMap (PixMapHandle pixMap, bool8 AddNonWhiteAlpha)=0
 
virtual const PixMapHandle GetPixMap () const =0
 
virtual bool8 GetAddNonWhiteAlpha () const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Data interface for PixMapImageStream segment of the image stream manager. This segment is used to target a pixmap as the source image for an ImageStreamManager conversion. This interface should probably be private.

See Also
IImageStreamManager

Member Enumeration Documentation

anonymous enum

Pixel channel value considered to be transparent

Member Function Documentation

virtual bool8 IPixMapImageStreamData::GetAddNonWhiteAlpha () const
pure virtual

Return the current AddNonWhiteAlpha value

virtual const PixMapHandle IPixMapImageStreamData::GetPixMap () const
pure virtual

Return the source image.

virtual void IPixMapImageStreamData::SetPixMap (PixMapHandle pixMap,
bool8 AddNonWhiteAlpha 
)
pure virtual

Set the pixmap used by PixMapImageStream.

Parameters
pixMap- IN: The source image. The client still owns the pixmap and should dispose of it after releasing the ImageStreamManager. Do not dispose of the pixMap until the ImageStreamManager is disposed.
AddNonWhiteAlpha- IN: The AddNonWhiteAlpha is used as follows: If kTrue then an alpha channel byte will added after each pixel (e.g., RGBARGBA...) where the value of each component is not kTransparentSampleValue. Additionally, if each component is kTransparentSampleValue, then the component will be set to 0xFF. So, a client could initialize an image buffer to kTransparentSampleValue, draw into the buffer, and any pixel which was marked by something other than kTransparentSampleValue in any of the components will have a non-zero alpha (effectively clipping out all other pixels).