RSurfaceManager::TSurfaceCreationAttributes Class Reference

class RSurfaceManager::TSurfaceCreationAttributes

Constructor & Destructor Documentation

TSurfaceCreationAttributes()

TSurfaceCreationAttributes ( ) [inline]

Default constructor, zero initializes all attributes.

Member Data Documentation

TInt iAlignment

TInt iAlignment

Alignment applied to the base address of each buffer in the surface: 1, 2, 4, 8 ,16, 32, 64 bytes or EPageAligned.

TInt iBuffers

TInt iBuffers

Number of buffers in the surface.

TCacheAttribute iCacheAttrib

TCacheAttribute iCacheAttrib

Caching attribute to create chunk memory. This value will be ignored if using a chunk which already exists.

TBool iContiguous

TBool iContiguous

Require physically contiguous memory. This value will be ignored if using a chunk which already exists.

TInt iHintCount

TInt iHintCount

Number of hints in the array iSurfaceHints. The number should not exceed the maximum number supported by the surface manager, see GetSurfaceManagerAttrib(EMaxNumberOfHints).

TBool iMappable

TBool iMappable

Should the surface be mappable. If EFalse any call to MapSurface() will fail with KErrNotSupported -- Note, some architectures may not support mappable surfaces.

TInt iOffsetBetweenBuffers

TInt iOffsetBetweenBuffers

Minimum or required offset between the start of one buffer and the start of the next one in bytes. When set to 0 the surface manager will choose how buffers are laid out within the chunk. If it is too small and doesn't fit with the alignment, CreateSurface() will return KErrArgument.

TInt iOffsetToFirstBuffer

TInt iOffsetToFirstBuffer

Minimum or required offset to the first buffer from the base of the chunk. Typically this will be set to 0. The value specified for the offset must comply with the alignment specified in iAlignment.

If iAlignment is page aligned, this value will be rounded up to a multiple of the page size when the surface is created, therefore the surface info must be queried for the actual value used.

TUidPixelFormat iPixelFormat

TUidPixelFormat iPixelFormat

The pixel format.

TSize iSize

TSize iSize

Width and height of the surface in pixels.

TInt iStride

TInt iStride

Minimum or required number of bytes between start of one line and start of next.

THintPair * iSurfaceHints

THintPair * iSurfaceHints

Array of hints which should be associated with the surface. This array must not contain duplicate hint keys.