VCL RAD DirectX for C++ Builder

Welcome to

www.tdxlibrary.org

Home of the
the TDx_Library...

=- RAD DirectX =-

"RAD DirectX"
for
C++ Builder

...

Welcome to tdxlibrary.org Latest News

Development Tools Demo Applications Step-By-Step Tutorials Component Reference

Register our Tools Available Downloads

Frequently Asked Questions Links to other sites Information about the tdxlibrary.org website


    TDx_Draw_Library v2.00 Component Reference

    -= Click to navigate the reference =-
    Go to the Welcome Page

    [ TDDSCaps::Caps ]     [ next: Caps2 ]    

    public:

        __property dword Caps = { read=FGetCaps, write=FSetCaps, default=0 };




    -= Go to the TDDSCaps description =-    TDDSCAPS::CAPS   [ component property ]

    • Description

        The Caps property defines flags indicating the capabilities of a surface.
        The described effect applies when the flag is set.
    • Flags

        DDSCAPS_3DDEVICE
        The surface this component describes can be used for 3D rendering.

        This flag can be used to ensure devices capable of only rendering to a certain heap will have off screen surfaces allocated from the appropriate heap.

        Setting this flag for a heap will make sure the surface is not allocated from it.

        DDSCAPS_ALPHA
        The surface this component describes is an alpha only surface.

        DDSCAPS_BACKBUFFER
        The surface this component describes is the back buffer of a flipping construct.

        TDx_Draw::CreateSurface() usually sets this flag when called with DDSCAPS_FLIP set.
        This flag will only be set on the surface immediately following a DDSCAPS_FRONTBUFFER surface in a flip chain.
        Other back buffers can be identified by having a DDSCAPS_FLIP flag, their attachment order and the absence of the DDSCAPS_FRONTBUFFER or DDSCAPS_BACKBUFFER flags.

        Using TDx_Draw::CreateSurface() with this flag set creates a stand alone back buffer which may then be attached with
        TDx_DrawSurface::AddAttachedSurface() to front, back or both buffers to form a flipping construct.
        An arbitrary number of flipping chain surfaces are supported.

        DDSCAPS_COMPLEX
        The surface this component describes is a complex surface.

        DDSCAPS_FLIP
        The surface this component describes is a part of a flipping construct.

        Pass this flag to TDx_Draw::CreateSurface() to create a front buffer and one or more back buffers.
        The DDSCAPS_FRONTBUFFER and DDSCAPS_BACKBUFFER flags will be set on the frontbuffer surface and the next surface in the chain respectively.
        The TDDSurfaceDesc::BackBufferCount used in the creation call must be at least 1 in order for the call to succeed.

        DDSCAPS_COMPLEX must always be set when creating multiple surfaces using TDx_Draw::CreateSurface().

        DDSCAPS_FRONTBUFFER
        The surface this component describes is the front buffer of a flipping construct.

        This flag is usually set by TDx_Draw::CreateSurface() when called using the DDSCAPS_FLIP flag.

        When TDx_Draw::CreateSurface() is called with this flag set, a stand-alone front buffer is created. It will not have DDSCAPS_FLIP set and it can be attached to other back buffers to form a flipping construct by using TDx_DrawSurface::AddAttachedSurface().

        DDSCAPS_HWCODEC
        The surface this component describes can have a data stream decompressed to it by the hardware.

        This would generally be a stream from a video port to an overlay surface but other uses are possible.

        DDSCAPS_LIVEVIDEO
        The surface this component describes is capable of receiving live video.

        DDSCAPS_LOCALVIDMEM
        The surface this component describes exists in local video memory.
        DDSCAPS_VIDEOMEMORY must also be set.
        This flag cannot be used with DDSCAPS_NONLOCALVIDMEM.

        DDSCAPS_MIPMAP
        The surface this component describes is a mipmap level.

        Other DDSCAPS_MIPMAP surfaces can be attached to form the mipmap by either creating a number of surfaces and attaching them using TDx_DrawSurface::AddAttachedSurface() or all at once using TDx_Draw::CreateSurface() to create a complex mipmap surface chain.

        DDSCAPS_TEXTURE must also be set.

        DDSCAPS_MODEX
        The surface this component describes is a 320 by 200 or 320 by 240 Mode X surface.

        DDSCAPS_NONLOCALVIDMEM
        The surface this component describes exists in nonlocal video memory.
        DDSCAPS_VIDEOMEMORY must also be set.
        This flag cannot be used with DDSCAPS_LOCALVIDMEM.

        DDSCAPS_OFFSCREENPLAIN
        The surface this component describes is an ordinary off screen surface.
        Not an overlay, texture, z-buffer, front-buffer, back-buffer or alpha surface.

        DDSCAPS_OVERLAY
        The surface this component describes is an overlay.
        DDSCAPS_VISIBLE can be used to determine if the overlay is visible.

        DDSCAPS_OWNDC
        The surface this component describes has a device context assigned to it.

        DDSCAPS_PALETTE
        The device driver allows unique palettes to be created and attached to the surface this component describes.

        DDSCAPS_PRIMARYSURFACE
        The surface this component describes is the primary surface.

        DDSCAPS_STANDARDVGAMODE
        The surface this component describes is a standard VGA mode surface.
        This flag cannot be used with DDSCAPS_MODEX.

        DDSCAPS_SYSTEMMEMORY
        The surface this component describes exists in system memory.

        DDSCAPS_TEXTURE
        The surface this component describes can be used as a 3D texture.
        This flag being set does not neccessarily mean the surface is being used as a 3D texture.

        DDSCAPS_VIDEOMEMORY
        The surface this component describes exists in display memory.

        DDSCAPS_VIDEOPORT
        The surface this component describes can receive data from a video port.

        DDSCAPS_VISIBLE
        Changes made to the surface this component describes will immediately be visible.
        This flag is always set for the primary surface, for overlays when they are being overlaid and texture maps while they are being textured.

        DDSCAPS_WRITEONLY
        Write access only is permitted for the surface this component describes.
        Trying to read this surface may generate general protection faults and the read results will not be meaningful.

        DDSCAPS_ZBUFFER
        The surface this component describes is a z-buffer.

    • See Also
    • Top





    If you would like to submit additions or improvements to this page, click: darren_john_dwyer@hotmail.com.



























Top

Welcome |  Latest News |  Tools |  Demos |  Tutorials |  Reference |  Register |  Downloads
FAQ |  Links |  Site Information

This page is Copyright © 2019 Darren John Dwyer, Australia. All Rights Reserved.
Borland C++ Builder, CBuilder, etc are Trademarks of Borland Corporation.
DirectX, DirectDraw, Windows, etc are Trademarks of Microsoft Corporation.