Skip to content

Add missing SAL Annotations for improved COM API wrapping #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add missing SAL Annotations for improved COM API wrapping #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions AmdDxExt.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
/**
***************************************************************************************************
* @file amddxext.h
* @brief AMD D3D Exension API include file.
* @brief AMD D3D Extension API include file.
***************************************************************************************************
*/
#ifndef _AMDDXEXT_H_
Expand Down Expand Up @@ -44,4 +44,4 @@ enum AmdDxExtFeatureToken
AmdDxExtFeature_DeviceCtxSupport = 3, // Device Ctx Support
};

#endif // _AMDDXEXT_H_
#endif // _AMDDXEXT_H_
4 changes: 2 additions & 2 deletions AmdDxExtApi.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
/**
***************************************************************************************************
* @file amddxextapi.h
* @brief AMD D3D Exension API include file. This is the main include file for apps using extensions.
* @brief AMD D3D Extension API include file. This is the main include file for apps using extensions.
***************************************************************************************************
*/
#ifndef _AMDDXEXTAPI_H_
Expand All @@ -26,7 +26,7 @@ interface ID3D11Device;
interface ID3D10Resource;
interface ID3D11Resource;

// App must use GetProcAddress, etc. to retrive this exported function
// App must use GetProcAddress, etc. to retrieve this exported function
// The associated typedef provides a convenient way to define the function pointer
HRESULT __cdecl AmdDxExtCreate(ID3D10Device* pDevice, IAmdDxExt** ppExt);
typedef HRESULT (__cdecl *PFNAmdDxExtCreate)(ID3D10Device* pDevice, IAmdDxExt** ppExt);
Expand Down
4 changes: 2 additions & 2 deletions AmdDxExtIface.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
***************************************************************************************************
* @file amddxextiface.h
* @brief
* AMD D3D Exension API include file. This is a helper include file for extensions. It
* AMD D3D Extension API include file. This is a helper include file for extensions. It
* provides a common base class for all extension interfaces
***************************************************************************************************
*/
Expand Down Expand Up @@ -38,4 +38,4 @@ class IAmdDxExtInterface
virtual ~IAmdDxExtInterface() = 0 {};
};

#endif // _AMDDXEXTIFACE_H_
#endif // _AMDDXEXTIFACE_H_
2 changes: 1 addition & 1 deletion AmdDxExtPerfProfile.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
***************************************************************************************************
* @file amddxextperfprofile.h
* @brief
* AMD D3D Exension API include file. This is a helper include file for extensions. It
* AMD D3D Extension API include file. This is a helper include file for extensions. It
* provides a common base class for all extension interfaces
***************************************************************************************************
*/
Expand Down
2 changes: 1 addition & 1 deletion AmdDxExtPerfProfileApi.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
***************************************************************************************************
* @file amddxextperfprofileapi.h
* @brief
* AMD D3D Perf Profile Exension API include file.
* AMD D3D Perf Profile Extension API include file.
* This is the main include file for apps using perf profile extension.
***************************************************************************************************
*/
Expand Down
18 changes: 9 additions & 9 deletions AmdExtD3D.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
/**
***********************************************************************************************************************
* @file AmdExtD3D.h
* @brief AMD D3D Exension API factory include file.
* @brief AMD D3D Extension API factory include file.
***********************************************************************************************************************
*/
#pragma once
Expand All @@ -45,10 +45,10 @@
// The app must use GetProcAddress, etc. to retrieve this exported function
// The associated typedef provides a convenient way to define the function pointer
HRESULT __cdecl AmdExtD3DCreateInterface(
IUnknown* pOuter, ///< [in] object on which to base this new interface; usually a D3D device
REFIID riid, ///< ID of the requested interface
void** ppvObject); ///< [out] The result interface object
typedef HRESULT (__cdecl *PFNAmdExtD3DCreateInterface)(IUnknown* pOuter, REFIID riid, void** ppvObject);
IUnknown* pOuter, ///< [in] object on which to base this new interface; usually a D3D device
REFIID riid, ///< ID of the requested interface
_COM_Outptr_ void** ppvObject); ///< [out] The result interface object
typedef HRESULT (__cdecl *PFNAmdExtD3DCreateInterface)(IUnknown* pOuter, REFIID riid, _COM_Outptr_ void** ppvObject);

/**
***********************************************************************************************************************
Expand All @@ -62,8 +62,8 @@ IAmdExtD3DFactory : public IUnknown
{
public:
virtual HRESULT CreateInterface(
IUnknown* pOuter, ///< [in] An object on which to base this new interface; the required object type
///< is usually a device object but not always
REFIID riid, ///< The ID of the requested interface
void** ppvObject) = 0; ///< [out] The result interface object
IUnknown* pOuter, ///< [in] An object on which to base this new interface; the required object type
///< is usually a device object but not always
REFIID riid, ///< The ID of the requested interface
_COM_Outptr_ void** ppvObject) = 0; ///< [out] The result interface object
};
2 changes: 1 addition & 1 deletion AmdExtD3DCommandListMarkerApi.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ IAmdExtD3DCommandListMarker : public IUnknown
virtual VOID PopMarker() = 0;
/// Set a command list marker to indicate a rendering activity
virtual VOID SetMarker(const char* pMarker) = 0;
};
};
7 changes: 3 additions & 4 deletions AmdExtD3DDeviceApi.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,8 @@
*/

#pragma once
#include "unknwn.h"
#include <unknwn.h>
#include <d3d12.h>
#include "AmdExtD3DDeviceApi.h"

/**
***********************************************************************************************************************
Expand Down Expand Up @@ -88,7 +87,7 @@ IAmdExtD3DDevice : public IUnknown
const AmdExtD3DCreateInfo* pAmdExtCreateInfo,
const D3D12_GRAPHICS_PIPELINE_STATE_DESC* pDesc,
REFIID riid,
void** ppPipelineState) = 0;
_COM_Outptr_ void** ppPipelineState) = 0;
};

/**
Expand All @@ -103,4 +102,4 @@ IAmdExtD3DDevice1 : public IAmdExtD3DDevice
virtual VOID PushMarker(ID3D12GraphicsCommandList* pGfxCmdList, const char* pMarker) = 0;
virtual VOID PopMarker(ID3D12GraphicsCommandList* pGfxCmdList) = 0;
virtual VOID SetMarker(ID3D12GraphicsCommandList* pGfxCmdList, const char* pMarker) = 0;
};
};
2 changes: 1 addition & 1 deletion AmdExtGpaInterfaceApi.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ IAmdExtGpaSession : public IUnknown
virtual UINT32 BeginSample(ID3D12GraphicsCommandList* pGfxCmdList, const AmdExtGpaSampleConfig& config) = 0;
virtual VOID EndSample(ID3D12GraphicsCommandList* pGfxCmdList, UINT32 sampleId) = 0;
virtual bool IsReady() const = 0;
virtual HRESULT GetResults(UINT32 sampleId, size_t* pSizeInBytes, void *pData) const = 0;
virtual HRESULT GetResults(UINT32 sampleId, _Inout_ size_t* pSizeInBytes, _Out_writes_bytes_opt_(*pSizeInBytes) void *pData) const = 0;
virtual HRESULT Reset() = 0;
virtual VOID CopyResults(ID3D12GraphicsCommandList* pGfxCmdList) = 0;
};
Expand Down