IReadAlphaImageStreamData Class Reference

#include <IReadAlphaImageStreamData.h>

Inheritance diagram for IReadAlphaImageStreamData:

Public Member Functions
virtual void	SetChannelToRead (uint16 index)=0
virtual void	SetChannelsPerPixel (uint16 channelsPerPixel)=0
virtual void	SetSourceBitsPerChannel (uint16 bits)=0
virtual void	SetIsPlanar (bool8 isPlanar)=0
virtual uint16	GetChannelToRead (void) const =0
virtual uint16	GetChannelsPerPixel (void) const =0
virtual uint16	GetSourceBitsPerChannel (void) const =0
virtual bool8	GetIsPlanar (void) 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 the ReadAlpha segment of the image stream manager. This segment can be used to read a particular channel of data from an image (typically an alpha channel). This interface should probably be private.

See Also

IImageStreamManager, IImageStream

Member Function Documentation

virtual uint16 IReadAlphaImageStreamData::GetChannelsPerPixel ( void  ) const

pure virtual

Retrieve the channels per pixel value specified via SetChannelsPerPixel

virtual uint16 IReadAlphaImageStreamData::GetChannelToRead ( void  ) const

pure virtual

Retrieve the channel specified via SetChannelToRead

virtual bool8 IReadAlphaImageStreamData::GetIsPlanar ( void  ) const

pure virtual

Retrieve whether or not the image data is planar. Specified via SetIsPlanar

virtual uint16 IReadAlphaImageStreamData::GetSourceBitsPerChannel ( void  ) const

pure virtual

Retrieve the bits per channel value specified via SetSourceBitsPerChannel

virtual void IReadAlphaImageStreamData::SetChannelsPerPixel ( uint16  channelsPerPixel )

pure virtual

Specify the number of channels in the source image.

Parameters

channelsPerPixel

- IN: refers to the total number of channels per pixel , including the alphas, which will be retrieved from the next image stream segment (the source data to this ImageStream).

virtual void IReadAlphaImageStreamData::SetChannelToRead ( uint16  index )

pure virtual

Specify the channel to read

Parameters

index

- IN: zero based and refers to the specific channel of data to retrieve. For example, if the image is RGB with 2 alphas (for a total of 5 channels) and you want the second alpha, pass 4.

virtual void IReadAlphaImageStreamData::SetIsPlanar ( bool8  isPlanar )

pure virtual

Specify whether the source image is planar or interleaved (chunky)

Parameters

isPlanar

- IN: kTrue for planar, kFalse for interleaved.

virtual void IReadAlphaImageStreamData::SetSourceBitsPerChannel ( uint16  bits )

pure virtual

Specify the bits per channel of the source data.

Parameters

bits	- IN: Number of bits per channel