os/graphics/graphicsresourceservices/graphicsresource/inc/sgdriver.h
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
sl@0
     1
// Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0
     2
// All rights reserved.
sl@0
     3
// This component and the accompanying materials are made available
sl@0
     4
// under the terms of "Eclipse Public License v1.0"
sl@0
     5
// which accompanies this distribution, and is available
sl@0
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0
     7
//
sl@0
     8
// Initial Contributors:
sl@0
     9
// Nokia Corporation - initial contribution.
sl@0
    10
//
sl@0
    11
// Contributors:
sl@0
    12
//
sl@0
    13
// Description:
sl@0
    14
//
sl@0
    15
sl@0
    16
/**
sl@0
    17
 @file
sl@0
    18
 @internalComponent
sl@0
    19
*/
sl@0
    20
sl@0
    21
#ifndef SGDRIVER_H
sl@0
    22
#define SGDRIVER_H
sl@0
    23
sl@0
    24
#include <e32std.h>
sl@0
    25
#include <pls.h>
sl@0
    26
sl@0
    27
sl@0
    28
class MSgDriverAdapter;
sl@0
    29
sl@0
    30
/**
sl@0
    31
@internalComponent
sl@0
    32
sl@0
    33
This class encapsulates the global data in the Graphics Resource DLL.
sl@0
    34
*/
sl@0
    35
NONSHARABLE_CLASS(XSgDriverPls)
sl@0
    36
	{
sl@0
    37
public:
sl@0
    38
	/**
sl@0
    39
	Default constructor, called when the Graphics Resource DLL is loaded into a
sl@0
    40
	process. Creates the mutex used to synchronise access to the global data. The
sl@0
    41
	mutex will be automatically destroyed by the kernel on process termination.
sl@0
    42
	*/
sl@0
    43
	XSgDriverPls();
sl@0
    44
public:
sl@0
    45
	/**
sl@0
    46
	Result code of the constructor.
sl@0
    47
	*/
sl@0
    48
	TInt iError;
sl@0
    49
	/**
sl@0
    50
	Handle to the mutex used to synchronise access to the global data.
sl@0
    51
	*/
sl@0
    52
	RMutex iMutex;
sl@0
    53
#ifdef __WINS__
sl@0
    54
	/**
sl@0
    55
	Handle to the Graphics Resource Adapter DLL owned by this process.
sl@0
    56
	*/
sl@0
    57
	RLibrary iLibrary;
sl@0
    58
#endif
sl@0
    59
	/**
sl@0
    60
	Number of times SgDriver::Open() has been called from this process without
sl@0
    61
	a corresponding call to SgDriver::Close().
sl@0
    62
	*/
sl@0
    63
	TInt iOpenCount;
sl@0
    64
	/**
sl@0
    65
	Pointer to the Graphics Resource Adapter singleton in this process.
sl@0
    66
	*/
sl@0
    67
	MSgDriverAdapter* iDriver;
sl@0
    68
	};
sl@0
    69
sl@0
    70
sl@0
    71
/**
sl@0
    72
@internalComponent
sl@0
    73
sl@0
    74
The UID3 value in the compound identifier of the Graphics Resource DLL.
sl@0
    75
*/
sl@0
    76
const TUid KSgResourceLibraryUid = {0x10285A70};
sl@0
    77
sl@0
    78
sl@0
    79
/**
sl@0
    80
@internalComponent
sl@0
    81
sl@0
    82
The global data in the Graphics Resource DLL.
sl@0
    83
*/
sl@0
    84
#ifdef __WINS__
sl@0
    85
#define gPls (*Pls<XSgDriverPls>(KSgResourceLibraryUid))
sl@0
    86
#else
sl@0
    87
extern XSgDriverPls gPls;
sl@0
    88
#endif
sl@0
    89
sl@0
    90
sl@0
    91
#endif // SGDRIVER_H