Méthode IDirectDrawSurface7::SetClipper (ddraw.h)

  • Article

Attache un objet clipper à cette surface ou en supprime un.

Syntaxe

HRESULT SetClipper(
  [in] LPDIRECTDRAWCLIPPER unnamedParam1
);

Paramètres

[in] unnamedParam1

Pointeur vers l’interface IDirectDrawClipper pour l’objet DirectDrawClipper à attacher à l’objet DirectDrawSurface. Si vous définissez ce paramètre sur NULL, l’objet DirectDrawClipper actuel est détaché.

Valeur retournée

Si la méthode réussit, la valeur de retour est DD_OK.

En cas d’échec, la méthode peut retourner l’une des valeurs d’erreur suivantes :

  • DDERR_INVALIDOBJECT
  • DDERR_INVALIDPARAMS
  • DDERR_INVALIDSURFACETYPE
  • DDERR_NOCLIPPERATTACHED

Notes

Lorsque vous définissez un clipper sur une surface pour la première fois, SetClipper incrémente le nombre de références du clipper ; les appels suivants n’affectent pas le nombre de références du clipper. Si vous passez NULL comme paramètre lpDDClipper , le clipper est supprimé de la surface et le nombre de références du clipper est décrémenté. Si vous ne supprimez pas le clipper, la surface relâche automatiquement sa référence au clipper lorsque la surface elle-même est relâchée. Selon les règles COM, votre application doit libérer toutes les références qu’elle contient au clipper lorsque l’objet n’est plus nécessaire.

SetClipper est principalement utilisé par les surfaces qui sont superposées à la surface primaire ou bitblttedées. Toutefois, il peut être utilisé sur n’importe quelle surface. Une fois qu’un objet DirectDrawClipper a été attaché et qu’une liste de clip lui est associée, l’objet DirectDrawClipper est utilisé pour les opérations IDirectDrawSurface7::Blt, IDirectDrawSurface7::BltBatch et IDirectDrawSurface7::UpdateOverlay qui impliquent l’objet DirectDrawSurface parent. SetClipper peut également détacher l’objet DirectDrawClipper actuel d’un objet DirectDrawSurface.

Spécifications

   
Plateforme cible Windows
En-tête ddraw.h
Bibliothèque Ddraw.lib
DLL Ddraw.dll

Voir aussi

IDirectDrawSurface7