Device.SetPaletteEntries Method

Article
10/19/2012

Sets the palette entries.

Namespace: Microsoft.WindowsMobile.DirectX.Direct3D
Assembly: Microsoft.WindowsMobile.DirectX (in Microsoft.WindowsMobile.DirectX.dll)

Syntax

'Declaration
Public Sub SetPaletteEntries ( _
    paletteNumber As Integer, _
    entries As PaletteEntry() _
)
'Usage
Dim instance As Device 
Dim paletteNumber As Integer 
Dim entries As PaletteEntry()

instance.SetPaletteEntries(paletteNumber, _
    entries)

public void SetPaletteEntries(
    int paletteNumber,
    PaletteEntry[] entries
)

public:
void SetPaletteEntries(
    int paletteNumber, 
    array<PaletteEntry>^ entries
)

public function SetPaletteEntries(
    paletteNumber : int, 
    entries : PaletteEntry[]
)

Parameters

paletteNumber
Type: System.Int32

An ordinal value that identifies the palette on which the operation is performed.

entries
Type: array<Microsoft.WindowsMobile.DirectX.Direct3D.PaletteEntry[]

A PaletteEntry structure that represents the palette entries to set. The number of PaletteEntry structures passed into entries is assumed to be 256.

Exceptions

Exception	Condition
InvalidCallException	The method call is invalid. For example, a method's parameter might contain an invalid value.

Remarks

For Direct3D applications, any palette sent to this method must conform to the SupportsAlphaPalette capability bit of TextureCaps. If SupportsAlphaPalette is not set, every entry in the palette must have alpha set to 1.0, or this method will fail and throw an DriverInvalidCallException. If SupportsAlphaPalette is set, any set of alpha values is allowed. Note that the debug runtime prints a warning message if all palette entries have alpha set to 0.

A single logical palette is associated with the device, and is shared by all texture stages.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Platforms

Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Compact Framework

Supported in: 3.5, 2.0

Share via