D3DCLIPSTATUS

The D3DCLIPSTATUS structure describes the current clip status and extents of the clipping region. This structure was introduced in DirectX 5.0.

typedef struct _D3DCLIPSTATUS {
    DWORD dwFlags; 
    DWORD dwStatus; 
    float minx, maxx; 
    float miny, maxy; 
    float minz, maxz; 
} D3DCLIPSTATUS, *LPD3DCLIPSTATUS;

Members

dwFlags

Flags describing whether this structure describes 2-D extents, 3-D extents, or the clip status. This member can be a combination of the following flags:

D3DCLIPSTATUS_STATUS

This structure describes the current clip status.

D3DCLIPSTATUS_EXTENTS2

This structure describes the current 2-D extents. This flag cannot be combined with D3DCLIPSTATUS_EXTENTS3.

D3DCLIPSTATUS_EXTENTS3

Not currently implemented.

dwStatus

Describes the current clip status. This member can be one or more of the following flags:

Combination and General Flags

D3DSTATUS_CLIPINTERSECTIONALL

Combination of all CLIPINTERSECTION flags.

D3DSTATUS_CLIPUNIONALL

Combination of all CLIPUNION flags.

D3DSTATUS_DEFAULT

Combination of D3DSTATUS_CLIPINTERSECTIONALL and D3DSTATUS_ZNOTVISIBLE flags. This value is the default.

D3DSTATUS_ZNOTVISIBLE

Indicates that the rendered primitive is not visible. This flag is set or cleared by the system when rendering with z-checking enabled (see D3DRENDERSTATE_ZVISIBLE).

Clip Intersection Flags

D3DSTATUS_CLIPINTERSECTIONBACK

Logical AND operation on the clip flags for the vertices, compared to the back clipping plane of the viewing frustum.

D3DSTATUS_CLIPINTERSECTIONBOTTOM

Logical AND operation on the clip flags for the vertices, compared to the bottom of the viewing frustum.

D3DSTATUS_CLIPINTERSECTIONFRONT

Logical AND operation on the clip flags for the vertices, compared to the front clipping plane of the viewing frustum.

D3DSTATUS_CLIPINTERSECTIONGEN0 through D3DSTATUS_CLIPINTERSECTIONGEN5

Logical AND operation on the clip flags for application-defined clipping planes.

D3DSTATUS_CLIPINTERSECTIONLEFT

Logical AND operation on the clip flags for the vertices, compared to the left side of the viewing frustum.

D3DSTATUS_CLIPINTERSECTIONRIGHT

Logical AND operation on the clip flags for the vertices, compared to the right side of the viewing frustum.

D3DSTATUS_CLIPINTERSECTIONTOP

Logical AND operation on the clip flags for the vertices, compared to the top of the viewing frustum.

Clip Union Flags

D3DSTATUS_CLIPUNIONBACK

Equal to D3DCLIP_BACK.

D3DSTATUS_CLIPUNIONBOTTOM

Equal to D3DCLIP_BOTTOM.

D3DSTATUS_CLIPUNIONFRONT

Equal to D3DCLIP_FRONT.

D3DSTATUS_CLIPUNIONGEN0 through D3DSTATUS_CLIPUNIONGEN5

Equal to D3DCLIP_GEN0 through D3DCLIP_GEN5.

D3DSTATUS_CLIPUNIONLEFT

Equal to D3DCLIP_LEFT.

D3DSTATUS_CLIPUNIONRIGHT

Equal to D3DCLIP_RIGHT.

D3DSTATUS_CLIPUNIONTOP

Equal to D3DCLIP_TOP.

Basic Clipping Flags

D3DCLIP_BACK

All vertices are clipped by the back plane of the viewing frustum.

D3DCLIP_BOTTOM

All vertices are clipped by the bottom plane of the viewing frustum.

D3DCLIP_FRONT

All vertices are clipped by the front plane of the viewing frustum.

D3DCLIP_LEFT

All vertices are clipped by the left plane of the viewing frustum.

D3DCLIP_RIGHT

All vertices are clipped by the right plane of the viewing frustum.

D3DCLIP_TOP

All vertices are clipped by the top plane of the viewing frustum.

D3DCLIP_GEN0 through D3DCLIP_GEN5

Application-defined clipping planes.

minx, maxx, miny, maxy, minz, maxz

x, y, and z extents of the current clipping region.

Requirements

  Windows NT/2000: Requires Windows NT 4.0 SP3 or later.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Version: Requires DirectX 2.0 or later.
  Header: Declared in d3dtypes.h.

See Also

IDirect3DDevice7::GetClipStatus, IDirect3DDevice7::SetClipStatus